Create API Token
Creates a new API token for the current tenant. The returned token can be used for subsequent authenticated API calls on behalf of this tenant.
Administrator role requiredThe API token used to call this endpoint must have the Administrator role. Requests from non-administrator tokens will be rejected.
Query Parameters
descriptionstring
Optional human-readable description saved with the token. Useful for identifying the token later in the UI or via the API token list.
HTTP Response Examples
200
{
"Status": true,
"Message": "",
"Response": {
"token": {
"DateCreated": "2026-04-18T12:00:00",
"Token": "igpnedehlkryvkpaszdm3jhyn-us-1",
"Description": "Zapier integration",
"TenantId": 0
}
}
}
HTTP Response Parameters
tokenobject
The newly created API token. Contains Token (the secret to use in Authorization headers), Description, DateCreated, and TenantId. Store the Token value securely — it cannot be retrieved again.