Getting Started
Get API access for your organization, create a key and send your first request.
1. Get API access
The Pult API is in beta. Pult switches it on for your organization on request: ask Pult support to enable it.
2. Create an API key
An organization admin creates keys in the Pult Dashboard:
- Go to Settings → Security → API keys and click Create API key.
- Enter a name (for example "Warehouse sync") and pick when the key expires.
- Copy the key. It is shown only once.
Treat the key like a password. Anyone who holds it can read your organization's data with your admin rights. See Authentication for what a key can read.
3. Send your first request
Send the key in the Authorization header, over HTTPS:
curl https://api.pult.com/v1beta/users \
-H "Authorization: Bearer pult_<key>"The answer is JSON. data holds the users, and pagination.nextCursor points to the next page, or
is null on the last one. See Pagination and windows.
Next steps
- Generate a client from the OpenAPI document, or browse the endpoints in the API reference.
- Read Errors and Rate limits before you run an integration unattended.
Last updated on