AlmondTill/G3N API

On this page

organizations

query · in the family Reading your records

What it does

The organization list — each entry is an organization — one store or business unit in your group.

The caller's org-group family's ACTIVE LISTING of Organizations — doomed records DROP from listings. PAGINATED: limit clamps to [1, 200], default 100; nextToken = the prior page's cursor, verbatim — opaque + tenant-bound (a malformed or foreign token → VALIDATION/INVALID). Walk until nextToken is null (a page may hold fewer than limit — doomed drop per page). STRUCTURED FILTER + SORT: filter = AND across clauses, OR within a clause's values; sort = one declared field, asc/desc. The declared Organization roster: caption (text) · status (enum) · code (text) · legalName (text) · jurisdiction (text) · createdAt (date) · updatedAt (date). An illegal filter/sort refuses VALIDATION/INVALID NAMING the exact problem (an unknown field teaches the roster). A filtered/sorted read evaluates the WHOLE family server-side, returns the EXACT matchCount, and its nextToken binds to THE ONE filter+sort that minted it — replaying it under a different filter/sort refuses. Absent both, the unfiltered lane is unchanged (matchCount null).

What happens

Reads only — changes nothing.

Who may call it

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

Arguments

NameTypeRequiredNotes
filterFilterInputnoWhich records to answer — clauses over the family’s filterable fields (the FilterInput type and the paging guide carry the grammar).
sortSortInputnoThe order to answer in — one declared field and a direction (the SortInput type carries the grammar).
limitIntnoHow many records to answer at most; a page may hold fewer.
nextTokenStringnoThe cursor from the previous page, passed back exactly as received.

Returns

OrganizationPage OrganizationPage! — One page of the organizations 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 ExampleOrganizations($limit: Int) {
  organizations(limit: $limit) {
    items {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      jurisdiction
      code
      legalName
      brandName
      operatingAsName
      owners
      costCentre
      primaryPhysicalFacility
      defaultCurrency
      stripeAccountRef
      stripeChargesEnabled
      stripeDetailsSubmitted
    }
    nextToken
    matchCount
  }
}

Variables:

{
  "limit": 1
}

Example response

{
  "data": {
    "organizations": {
      "items": [
        {
          "id": "01900000-0000-7000-8000-37386ae00000",
          "sysId": "OR-EXMP-0000-000F",
          "type": "Organization",
          "caption": "Blue jeans",
          "status": "<status>",
          "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",
          "jurisdiction": "<jurisdiction>",
          "code": "BJ-001",
          "legalName": "Blue jeans",
          "brandName": "Blue jeans",
          "operatingAsName": "Blue jeans",
          "owners": [
            "01900000-0000-7000-8000-f89daae50000"
          ],
          "costCentre": "<cost centre>",
          "primaryPhysicalFacility": "01900000-0000-7000-8000-925e35910000",
          "defaultCurrency": "<default currency>",
          "stripeAccountRef": "<stripe account ref>",
          "stripeChargesEnabled": true,
          "stripeDetailsSubmitted": true
        }
      ],
      "nextToken": "<the cursor from the previous page>",
      "matchCount": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer