GoliathDevelopersGet an API key
Reference/Pipeline Itemsgenerated from the gateway manifest

listPipelineRoles

The org's roles of one kind.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

The org's roles of one kind (CONTACT when omitted): CONTACT a pipeline item's people, USER teammates, PROPERTY a pipeline item's properties, ITEM_LINK linked pipeline items, RELATIONSHIP related people, CONTACT_PROPERTY a contact's properties. pipelineItemId: the roles its pipeline owner offers. Ids for every set…Role op.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listPipelineRoles",
    "variables": {}
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.pipelineItems.listPipelineRoles({})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'listPipelineRoles',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

kindPipelineRoleKind

Which link a pipeline role labels: a person on an item (CONTACT), a teammate on an item or a contact (USER), a property on an item (PROPERTY), an item linked to an item (ITEM_LINK), a related person's link to their main contact (RELATIONSHIP), or a contact's property (CONTACT_PROPERTY). A role never changes kind.

CONTACTUSERPROPERTYITEM_LINKRELATIONSHIPCONTACT_PROPERTY
pipelineItemIdID

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "pipelineItemQuery": {
      "listPipelineRoles": [
        {
          "id": "<ID>",
          "kind": "CONTACT",
          "name": "…",
          "onlyOne": true
        }
      ]
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READgetPipelineItemREADfindPipelineItemsREADsurveyPipelineItemsREADlistStalledPipelineItemsREADlistPipelinesREADlistPipelineItemFilters