Run a governed GraphQL read

Open the explorer

Open Administration → Access policies & relationship queries → Governed GraphQL read API with a platform administrator. The GraphQL operation itself uses the authorized agent session and tenant policies. Portal-only and inventory-counter-only sessions cannot use the agent endpoint. Under Platform administration & configuration → Foundation, check Governed GraphQL reads and advanced record queries if the endpoint is unavailable.

Read a page

Send one JSON request to POST /api/graphql with a query and optional variables and operationName. The transport accepts reads. Use the administrator schema view at GET /api/graphql/schema to inspect typed roots and supported fields.

query ReadIncidents($limit: Int!, $offset: Int!) {
  incident(limit: $limit, offset: $offset, sort: "id",
    filter: {field: "state", operator: equals, value: "new"}) {
    total limit offset nextOffset hasMore
    items { id number title state previewTruncatedFields }
  }
}

Use variables such as limit = 10 and offset = 0. Read the returned pagination values for the next page. Field references return IDs, and a null can indicate either an unset value or a field the caller cannot read. Use the record detail with an authorized role to check any value you expect to see.

Troubleshoot responses

Inspect the GraphQL errors array even when HTTP returns 200. If the document is rejected, reduce it to one root and a few fields and verify names against the schema. Supported limits include four root selections, combined requested page sizes of 100, up to 40 selected fields per record including ID, and a 2 MiB response limit. A truncated text preview is identified in previewTruncatedFields. Reduce page sizes and projection before retrying a bounded read. See REST and API errors.