Skip to main content

Endpoint

Authentication

This endpoint requires an OAuth access token. Send it as a bearer token:
Required scope: users:read

Request Example

Response

Success Response

Status Code: 200 OK

Response Fields

Entity Object Fields

Each entity in the entities array contains:

Error Responses

400 Bad Request

Returned when the access token has no user behind it. client_credentials tokens act as the admin who created the application, so this applies only to tokens issued before application creators were recorded.

401 Unauthorized

Returned when the access token is missing, unknown, revoked, or expired, or when an X-API-Key was sent instead of a bearer token. See OAuth error responses.

403 Forbidden

Returned when the token does not carry the required scope.

404 Not Found

Returned when the organization cannot be found.

429 Too Many Requests

Returned when your organization exceeds its per-minute request limit.

500 Internal Server Error

Returned when the request fails due to a server error.

Notes

rate_limit_per_minute is null here because OAuth traffic is limited per organization, not per credential. Read your current limit from the X-RateLimit-Limit response header instead.
To find out which user and scopes a token resolves to, use Get Current User.

Use Cases

This endpoint is useful for:
  • Verifying a token - Confirm the token resolves to the organization you expect
  • Retrieving organization context - Get information about the organization for integration purposes
  • Entity management - Access the list of legal entities configured in the organization