The Ankored Customer API lets your organization connect its own systems to Ankored. Instead of uploading spreadsheets or exporting reports by hand, your systems can add and update members, manage programs and membership, and read compliance status automatically.
For full technical documentation, see the Ankored Customer API developer documentation.
What you can do with the Customer API
Add and update members: create members in batches, placing each one in a program with a role, and update members using your own system's ID for each person.
Manage programs: create or update programs so your structure in Ankored matches your own.
Manage membership: move members between programs and roles, activate or deactivate memberships, and remove members from a program. When a membership is activated or deactivated, Ankored automatically updates the member's requirements.
Read compliance status: pull compliance status for your whole organization, for one member, or for everyone under an email address (including children's profiles). You can also check only for changes since your last check.
How members and compliance status work in the API
Groups are programs. The developer documentation uses the word "groups." These are the same as the Programs you see in Ankored.
Status is tracked per membership. A member can belong to more than one program and role, and each membership has its own compliance status. That's why compliance data from the API comes back as one row per membership, not one row per person.
Removing a member's last membership deletes their profile. If you remove a member from their only program through the API, their Ankored profile is deleted. To keep a member's history, deactivate their membership instead.
Is the Customer API right for my organization?
The Customer API is built for organizations that have their own technical team and want Ankored to work with systems they already use. Common examples include:
Automatically adding new staff to Ankored from an HR system
Pulling compliance status into a business intelligence tool or data warehouse for reporting
Showing Ankored compliance data inside an internal tool your organization built
If you use the LeagueApps integration, members are already added to Ankored through LeagueApps. In that case, organizations typically use the Customer API to read compliance data, not to add members.
Who builds the integration?
Your organization is responsible for building and maintaining its integration with the Customer API. Ankored provides the API, the developer documentation, and access to API keys, and enables the API for your account. Ankored does not build, host, or maintain integrations on your behalf.
Before you get started, make sure you have a developer or IT team who can build the integration and support it over time.
Availability and cost
The Customer API is an add-on available to organizations on Gold and Platinum plans, and it comes at an additional cost. It is not included in your plan by default, and it must be enabled for your organization. If you would like to add it, contact your Ankored account team at [email protected].
Getting started
Ask us to enable the Customer API for your organization by emailing [email protected]. Because the Customer API is an additional cost, your account team will confirm pricing with you before it is turned on.
Create an API key. An admin with Org Admin access goes to Manage Account, then API Setup, and creates a key. If the page shows the API isn't enabled for your account yet, contact your Ankored account team. The key's secret is shown only once, so copy it and store it somewhere secure, such as your organization's password or secrets manager.
Share the key with your developers along with the developer documentation. The first step there is a connection test to confirm the key works.
Managing your API keys
Org Admins can create, rename, and revoke API keys on their own from Manage Account, then API Setup. You don't need to contact Ankored to get or replace a key.
If a key is ever shared by mistake or no longer needed, revoke it right away and create a new one.
Each key is tied to your organization only. It can only read and change your organization's data.
Good to know
Your system becomes the source of truth for the members it manages. If your system adds members to Ankored through the API, make changes to those members, such as an email address update, in your system so the two stay in sync.
The Customer API is different from the Partner API. The two offer the same actions, but the Partner API is for platforms that manage many organizations. The Customer API is limited to a single organization's own data.
Need help?
For technical details, see the Customer API developer documentation. For questions about enabling the API, pricing, or your account, contact [email protected].