Pult Docs

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:

  1. Go to Settings → Security → API keys and click Create API key.
  2. Enter a name (for example "Warehouse sync") and pick when the key expires.
  3. 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

Last updated on

On this page