AlmondTill/G3N API

On this page

contacts

query · in the family Contact

What it does

The contact list — each entry is a contact — a person or address book entry.

The caller's org-group family's ACTIVE LISTING of Contacts — doomed records DROP from listings.

What happens

Reads only — changes nothing.

Who may call it

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

Returns

Contact [Contact!]! — A contact — the UNIFIED, REUSABLE contact-info master: one group-scoped record holding an optional PERSON block and/or an optional INLINE address block (at-least-one-of — an empty contact is refused at the boundary), attached to hosts via role-tagged ContactAssignments. Group-scoped like a Brand (parent = the org group). Carries EXTERNAL-party + functional addresses ONLY — the PhysicalFacilityLocation stays the SOLE physical-address holder for OUR facilities (the PFL fence). Deactivate AND doom are BOTH blocked by live (active) assignments.

Example request

query ExampleContacts {
  contacts {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    notes
  }
}

Example response

{
  "data": {
    "contacts": [
      {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "sysId": "CO-EXMP-0000-000F",
        "type": "Contact",
        "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",
        "notes": "Restock before the weekend."
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer