Authentication
The AchieveApex REST API lets you read and write the data of your organization: contacts, companies, deals, conversations, support tickets, products, reservations, loyalty, AI assistants and more. Every request is authenticated with an organization API key sent in the x-api-key header.
Using an AI assistant? Download the whole reference as one file or point ChatGPT/Claude to it. See Use with AI and LLMs.
Base URL
https://integrations.achieveapex.com
All paths in this reference are relative to the base URL: /contacts means https://integrations.achieveapex.com/contacts. The API only accepts HTTPS. Requests and responses are JSON (Content-Type: application/json).
Create an API key
- In AchieveApex, go to Settings → Developers → API Keys.
- Create a key and copy it. Each key belongs to one organization and to the user who created it.
- Store it in a secret manager or an environment variable. You can deactivate a key and create a new one at any time.
Important: an API key gives full access to all the data of its organization. Never put it in browser code, mobile apps or public repositories.
Send the key on every request
There is no login step. Add the header to every call:
x-api-key: YOUR_API_KEY
Content-Type: application/json
Organization scope
- An API key only works inside the organization it was created in. Reads are filtered to that organization automatically, even if the user who created the key belongs to other organizations or is an AchieveApex admin.
- Sending another organization's
organization_id(in the body or as a filter) returns403 Forbidden. - Most resources require
organization_idin the body ofPOSTrequests: use your organization's ID (GET /organizationsreturns it). - The key keeps the role its user has in that organization (owner, admin or member), so owner/admin-only actions need a key created by an owner or admin.
- Changing
organization_idon an existing record is not allowed.
Authentication errors
| Status | When | Example body |
|---|---|---|
401 Unauthorized | The key does not exist or is inactive. | {"name":"NotAuthenticated","message":"Invalid API key","code":401,"className":"not-authenticated"} |
403 Forbidden | No x-api-key header was sent (anonymous request), or the resource is not available to API keys. | {"name":"Forbidden","message":"Access denied: You do not have permission to view contacts. ...","code":403,"className":"forbidden"} |
429 Too Many Requests | The organization exceeded its rate limit. | See Errors and rate limits. |
Next steps
- Requests, filtering and pagination: how to list, filter, sort and page through any resource.
- Errors and rate limits
- Use with AI and LLMs: one-file download, OpenAPI spec and prompts.
- Start with a resource, for example Contacts.
Report an issue with this documentation
Please log in to report issues with our documentation.