OrgsAPI Tokens

getOrgApiToken

GET
/api/v1/orgs/{org_id}/apitokens/{apitoken_id}

Return metadata for one organization API token. The full token key is only available at creation time and may only be partially shown afterward.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
apitoken_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/apitokens/000000ab-00ab-00ab-00ab-0000000000ab"
{  "created_by": "user@mycorp.com",  "created_time": 1626875902,  "id": "497f6eca-6276-4993-bfeb-53efbbba6f08",  "key": "1qkb...QQCL",  "last_used": 1690115110,  "name": "org_token_xyz",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "privileges": [    {      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",      "role": "admin",      "scope": "org"    }  ]}