Tribal Habits has an extensive Public API for managing users, enrolments and more.
Warning: This feature requires a Business 50 plan or larger
Please note that access to our API is only available on Business 50 or larger plans. This feature is not available on smaller plans (such as Lite) or legacy plans (older monthly plans). Please contact our team at [email protected] if you would like access to this feature but it is not activated in your portal.
How can I check if our API is enabled in my portal?
To check if our API is enabled in your portal, log in to your portal as a Super Admin and navigate to Admin → Account → Integrations.
In the Integrations panel on that page, you will see a tile for Public API which will indicate if your access to our Public API is enabled. If not, please contact Support to request that the Public API is enabled in your portal.
Once the Public API is enabled, you will find your Public API key in the same Integrations panel. Please keep this key secure at all times.
Our developer documentation for the Tribal Habits Public API has a page for each endpoint. Each page lists the endpoint's parameters and allowed values, example requests in several programming languages, and example responses for each status code. The documentation also includes guides on authentication, custom fields, error codes, rate limits and requesting certificates.
What can the Public API be used for?
The Public API can be used to build custom integrations of your own between our platform and other platform with RESTful APIs. It allows you to:
Get details on users
Create new users
Update existing users
Get details on topics and pathways
Create and update enrolments in topics and pathways
Create new external knowledge records
Request certificates
Update external knowledge records
Note: Requests to the Public API are rate limited. Requests that exceed the limit are blocked (response code 429) for one minute. See the rate limits guide in our developer documentation for current limits, including the separate limit for certificate requests.
Warning: If you want to create Zapier zaps with Tribal Habits, you must use a Zapier API key from Tribal Habits. Do not use a Public API key or any other API key from our integrations page. If you are finding that your Tribal Habits triggers are not firing in your zaps it may be because you have used a Public API key instead of a Zapier API key.