return

Fetch return records matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
idString!Yes

Filter by ID; pass the public API ID unless the field name says legacy ID. Required.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ReturnQueryResult

Query

query return(
  $id: String!,
  $analyze: Boolean
) {
  return(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ReturnFragment
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "analyze": true
}

Response

{
  "data": {
    "return": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "UmV0dXJuOjEyMzQ="}
    }
  }
}