API Overview & Authentication
The AOH Sync Public API gives you programmatic access to your tenant's identity data, sync operations, and webhook subscriptions. You can query identities and users, trigger sync jobs, and receive real-time event notifications — all scoped to your tenant.
Base URL
The base URL for the Public API is environment-specific — it depends on how your AOH Sync instance is deployed and exposed. All endpoints are versioned under /v1/. The /v1/health endpoint is unauthenticated; every other endpoint requires an API key.
Authentication
Every authenticated request must include your API key in the X-API-Key request header:
GET /v1/identities HTTP/1.1
X-API-Key: your-api-key-hereThere is no other authentication method for the Public API. Requests that omit the header, or that supply an invalid key, receive a 401 Unauthorized response.
Tenant scoping
Your API key is bound to your AOH Sync tenant. All data returned by the API — identities, users, sync jobs, webhooks — belongs to that tenant only. You cannot query data from other tenants.
How to obtain an API key
Store your key securely. Treat it like a password — it grants full read/write access to your tenant's API surface.
Making a request
Here is a minimal example using curl to list identities:
A successful response includes a data array, plus pagination fields (total, limit, offset):
Pagination
List endpoints (/v1/identities, /v1/users) support limit and offset query parameters. The default page size is 50. Use offset to step through large result sets.
limit
integer
50
Number of results to return
offset
integer
0
Number of results to skip
Related
Last updated