🔒 Access to Famly's API is available to US Essentials and Premium packages. Please reach out to support@famly.co if you're interested in enabling this for your site.
GraphQL Famly API documentation
The API is implemented using GraphQL, and is available here:
https://famlyapi.famly.co/v1/graphql
We strongly recommend getting familiar with GraphQL using their excellent documentation at https://graphql.org before getting started with the Famly API.
For a more detailed overview, take a look at our Public GraphQL API Reference documentation here.
Supported query and mutation roots
We currently support these query/mutation roots:
employees
groups
meals
sites
children
contacts
enquiries
files (only mutations)
payments (only mutations, querying coming soon)
invoices (only mutations, querying coming soon)
bill payers (only mutations, querying coming soon)
Explore the API
GraphiQL
We host GraphiQL, which you can use to experiment with queries. Note that you won't be able to run most queries without authenticating. You can click Docs in the upper right corner to see relevant documentation.
On the left side in GraphiQL, you will see examples of queries and mutations in the top, and the variables and arguments in the bottom. These are helpful for inspiration and to get quickly started using the API.
Voyager
We also host Voyager, which gives you a more visual overview of how the API is built.
Authentication
You will need an access token to use the Public API. Contact Famly Support at support@famly.co to get an access token assigned to your user.