Skip to main content

Partner API: what it is, and what it is not

The Asanify Partner API is a private, read-only HTTP API your ERP or data warehouse uses to pull HR and payroll data out of Asanify. Start here for what it covers and what it deliberately does not.

Written by Vaibhav Kashyap

What it is

A private, read-only HTTP API your systems call directly. It is versioned — every path below starts with /v1 — and there are 14 endpoints, grouped into 8 topics that each have their own article in this collection.

Your API key is bound to one company. Every response is scoped to your own data, and there is no parameter anywhere in this API that selects a company — so a key cannot be pointed at anyone else's records, by accident or otherwise.

Your key also carries a set of scopes, and those decide which of the endpoints it can call. See *Partner API: scopes, and how to ask for more*.

What it is not

  • It does not write. No endpoint on this surface creates, updates or deletes anything. An integration that needs to push data into Asanify cannot use this API.

  • It does not push. There are no webhooks and no callbacks. Your side polls on whatever schedule suits you.

  • There are no SDKs or client libraries. It is plain HTTP and JSON; use whatever your stack already has.

  • There is no public developer portal. This collection and the Postman collection your Asanify contact can send you are the reference.

Where to start

  • Read *Partner API: authentication and your first call* and get a 200 back before writing any code.

  • Check *Partner API: scopes, and how to ask for more* against what your key was actually granted.

  • Read *Partner API: pagination, field selection and identifiers* before you write the sync loop. It is the part integrations most often get wrong.

  • Then work through the endpoint article for each topic you need.

Did this answer your question?