AlmondTill/G3N API

On this page

contactAssignments

query · in the family Contact assignment

What it does

The contact assignment list — each entry is a contact’s assignment to a record — who is the buyer on this vendor, the manager at this store.

The caller's org-group family's ACTIVE LISTING of ContactAssignments — 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

ContactAssignment [ContactAssignment!]! — A contact assignment — ONE role-tagged attachment of a Contact to a HOST construct (org group / organization / logical facility / vendor / corporate customer). Parent = the HOST (the CollectionMember stance — hostId rides the header parentId). The (contact, host, role) triple is unique (a live duplicate is CONFLICT/IDENTITY_TAKEN naming the holder); REMOVE = doom (TWO_STATE — history preserved); re-assigning mints a NEW record via marker takeover. Role↔host applicability is registry DATA. At most 48 live assignments per host.

Example request

query ExampleContactAssignments {
  contactAssignments {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    contactId
    hostType
    role
  }
}

Example response

{
  "data": {
    "contactAssignments": [
      {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "sysId": "CA-EXMP-0000-000F",
        "type": "ContactAssignment",
        "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",
        "contactId": "01900000-0000-7000-8000-4db757ce0000",
        "hostType": "organization_group",
        "role": "<role>"
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer