Error responses

When an API request fails, an error response is returned that includes a structured error object. This error object contains:

• A code property with a standardized error code that can be used for programmatic error handling.
• A message property with a human-readable description of what went wrong.

For example:

{
  "code": "team_not_found",
  "message": "Team {teamId} not found"
}

The following error codes can be returned by the Admin APIs:

• permission_denied
• too_many_requests
• max_limit_reached
• bad_request_body
• bad_http_method
• bad_request_params
• bad_query_params
• endpoint_not_found
• invalid_access_token
• missing_scope
• invalid_field
• input_unsafe
• display_name_unavailable
• team_not_found
• group_not_found
• user_not_found
• user_not_managed

Use the error code to handle errors programmatically in your application. The error codes are standardized across all Admin API endpoints, so you can implement consistent error handling logic. The specific errors an individual endpoint can return are shown in the Error responses section of that endpoint's reference page.