AlmondTill/G3N API

On this page

orgBrand

query · in the family Org brand

What it does

Look up one record — your organization’s enablement of a shared brand — switching it on locally.

A OrgBrand by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.

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
idID ID!yesThe id of the record.

Returns

OrgBrand — An OrgBrand selection — the per-org ENABLEMENT of a group Brand (the strict-selection pattern: no org-scoped Brand reference without an ACTIVE selection). Parent = the ORGANIZATION (not the family root). Freely deactivatable/doomable; a NON-doomed selection blocks the master Brand doom only.

Example request

query ExampleOrgBrand($id: ID!) {
  orgBrand(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    brandId
    code
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "orgBrand": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "EB-EXMP-0000-000F",
      "type": "OrgBrand",
      "caption": "Blue jeans",
      "status": "active",
      "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",
      "brandId": "01900000-0000-7000-8000-4067736b0000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer