Skip to main content
Stay up to date. Subscribe to API changelog updates in your preferred feed reader or automation.
View all updates

Standard error format and error reference

Partner APIs now return errors in a consistent JSON envelope, with a searchable reference for common and service-specific error codes.

Error response format​

Each error response includes:

  • status_id — numeric status matching the error code
  • code — machine-readable error code
  • message — human-readable summary
  • fields — affected field paths and their validation details; an empty array when no field-level detail exists
  • doc_url — link to the relevant error documentation

Error reference​

The Errors reference lists common and service-specific codes, their numeric and HTTP statuses, and descriptions. Search by code, status, or description, then use the linked anchor from doc_url to open the matching entry.

For resolution steps, see Error Handling, which currently includes guidance for resolving PERMISSION_DENIED.