🔒 API access is not available on all packages, contact support@famly.co to check whether you should have access
This article explains which APIs are available in Famly, how to generate an access token, and what to consider when building integrations.
Available APIs
Famly provides both a Public API and an Internal API.
Public API
Documentation is available here: https://docs.famly.co/
GraphQL endpoint: https://famlyapi.famly.co/v1/graphql
Internal API
GraphQL endpoints
REST endpoints
Getting an Access Token
Below you can find instructions on how to obtain an access token that can be used with either a single site or your entire organisation when working with the APIs.
A few things to note about API tokens:
Always check the expiry of the token
You will receive a reminder seven days before the token expiresOnly grant the absolute minimum permissions needed
Access tokens work for both the Public API and the Internal API
💡 Never share access tokens via unsafe channels such as email or chat.
Organisation Access Token
To create an organisation-level token:
Navigate to Home
Select the organisation in the Site picker
Click Settings
Click Show under Manage API tokens
Add a new token
Site Access Token
To create a site-level token:
Navigate to Settings
Click Integrations
Click Manage API tokens
Add a new token
Public API
The Public API is the preferred option when building integrations with Famly. In some cases, you may not be able to find the data you need there. If that happens, you can consider using the Internal API instead.
What is the Internal API
Famly’s Internal API is what the Famly app itself uses to communicate with the backend. It consists of two parts:
A GraphQL API, which is similar to the Public API but contains significantly more fields and endpoints
A REST API
Because the frontend relies on it, everything visible in the app is technically accessible through this API.
Finding the Data Flows
The best way to understand the data flows is to open your browser’s network inspector. You can then perform the actions you want to replicate in your integration through the Famly interface and observe which network requests are sent and where they go.
Using this method, you can see both the parameters sent to the backend and the responses returned to the frontend.
Tools to Ease Your Work
We strongly recommend using Postman for building and testing your API calls. It includes many helpful tools for both REST and GraphQL workflows.
Access
There are no separate access restrictions for the APIs. The API keys you generate already work for both the Public and Internal APIs. Access is not something Famly formally grants or restricts on a technical level.
Limitations and Conditions to Understand
Before integrating with the Famly Internal APIs, you must explicitly acknowledge the following:
No support provided
Famly does not provide support for integrations built against the Internal API. If something breaks, Famly cannot be expected to help diagnose or fix the issue.No backward compatibility guarantee
Unlike the Public API, where backward compatibility is guaranteed, the Internal API can and does include breaking changes when parts of the app are refactored. These changes may occur without warning.No documentation support
There is no curated, customer-facing documentation for the Internal API. You will need to identify endpoints yourself by inspecting network traffic from the Famly app.
‼️ You build entirely at your own risk