AlmondTill/G3N API

On this page

casesByConsumer

query · in the family Reading your records

What it does

All the service cases one customer has had — their support history.

ONE consumer's cases, NEWEST-FIRST + born-paginated. consumerId is the REQUIRED anchor (tenant-scoped). Cancelled drops per page; closed history stays. Requires authentication.

What happens

Reads only.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
consumerIdID ID!yesNo further notes.
limitIntnoHow many records to answer at most; a page may hold fewer.
nextTokenStringnoThe cursor from the previous page, passed back exactly as received.

Returns

CsCasePage CsCasePage! — One page of the csCases listing — the records + the opaque resume cursor.

This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.

Example request

query ExampleCasesByConsumer($consumerId: ID!, $limit: Int) {
  casesByConsumer(consumerId: $consumerId, limit: $limit) {
    items {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      caseType
      priority
      origin
      consumerId
      organizationId
      orderId
      appointmentId
      returnId
      fulfillmentId
      paymentId
      warrantyId
      linkedFromCaseId
      assignedTo
      slaDueAt
    }
    nextToken
  }
}

Variables:

{
  "consumerId": "01900000-0000-7000-8000-6e8c92ec0000",
  "limit": 1
}

Example response

{
  "data": {
    "casesByConsumer": {
      "items": [
        {
          "id": "01900000-0000-7000-8000-37386ae00000",
          "sysId": "CS-EXMP-0000-000F",
          "type": "CsCase",
          "caption": "Blue jeans",
          "status": "open",
          "parentId": "01900000-0000-7000-8000-065235280000",
          "rootId": "01900000-0000-7000-8000-a093dd800000",
          "createdAt": "2027-01-31T00:00:00.000Z",
          "updatedAt": "2027-01-31T00:00:00.000Z",
          "revisionNum": 1,
          "revision": "01900000-0000-7000-8000-b7960e180000",
          "caseType": "<case type>",
          "priority": "<priority>",
          "origin": "<origin>",
          "consumerId": "01900000-0000-7000-8000-6e8c92ec0000",
          "organizationId": "01900000-0000-7000-8000-44b781470000",
          "orderId": "01900000-0000-7000-8000-f6d8263a0000",
          "appointmentId": "01900000-0000-7000-8000-d4398f970000",
          "returnId": "01900000-0000-7000-8000-4d4c03d20000",
          "fulfillmentId": "01900000-0000-7000-8000-82dcede40000",
          "paymentId": "01900000-0000-7000-8000-a7c488a40000",
          "warrantyId": "01900000-0000-7000-8000-5da144780000",
          "linkedFromCaseId": "01900000-0000-7000-8000-f5ec54b10000",
          "assignedTo": "01900000-0000-7000-8000-f10ad02c0000",
          "slaDueAt": "2027-01-31T00:00:00.000Z"
        }
      ],
      "nextToken": "<the cursor from the previous page>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer