Endpoint
Authentication
This endpoint requires an OAuth access token. Send it as a bearer token:users:read
Request Example
Response
Success Response
Status Code:200 OK
Response Fields
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 anX-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 token’s user no longer exists in the organization.429 Too Many Requests
Returned when your organization exceeds its per-minute request limit.Notes
This endpoint exists only on the OAuth surface. There is no API-key equivalent, because an API key is
not tied to a specific end user.
Use Cases
- Token verification - Confirm a freshly issued token works before making real calls
- Capability discovery - Enable or hide features in your UI based on the granted
scopes - User identification - Display who your integration is acting as
- Debugging permissions - Explain a
403by checking the token’s user and scopes