Core concepts

Errors and request IDs

Errors use one stable envelope and include a request ID for support and tracing.

Error envelope

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Screen not found.",
    "requestId": "request_id"
  }
}

Include the request ID when contacting support. The optional details member is used for safe validation information.

Status codes

Status	Meaning
`400`	The request parameters are invalid.
`401`	The Partner credential is not valid.
`403`	The credential lacks the required scope.
`404`	The tenant-scoped resource was not found.
`426`	HTTPS is required in production.
`429`	A credential or organization quota was exceeded.
`500`	An unexpected server error occurred.

Resource privacy

A missing resource and a resource owned by another organization return the same resource-specific 404. This prevents tenant information from being inferred.