Skip to main content
Before you start, you need:
  • OrgName and ApiKey: issued by Noyax.
  • User ID (X-UserID): the Noyax user the requests are made on behalf of.
  • Company ID (X-CompanyID): the company whose data you access. The user must be assigned to this company.
1

Get an access token

Exchange your API key for an access token and a refresh token at the auth service.
Access tokens are valid for 20 minutes. When one expires, log in again or use the refresh token to get a new one. See Authentication.
2

Make your first request

Put the token in the Authorization header and the user and company IDs in X-UserID and X-CompanyID.
3

Read the response

Records are in Data.Items and the total record count is in Data.TotalCount.
The X-RateLimit-Remaining and X-Daily-Remaining response headers show how many requests you have left this second and today (rate limits).

Next steps

Try every endpoint in Postman

Download the collection and environment, and call every endpoint with your API key.

Create a customer

Create a customer with addresses, telephones and other sub-records in one request.