GoliathDevelopersGet an API key
Reference/Employeesgenerated from the gateway manifest

listEmployeeChannelOptions

What an AI employee can be bound to right now.

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

What an AI employee can be bound to right now: availableMailboxes (connected Gmail or Outlook inboxes shared with the organization that no employee owns yet; the id attachEmployeeMailbox takes) and availableTriggerForms (the organization's forms, any status; ids for setEmployeeTriggerForms). Phone numbers are not assigned to employees: an employee replies on the number the conversation is on, otherwise a shared organization number.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listEmployeeChannelOptions",
    "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.employees.listEmployeeChannelOptions()
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: 'listEmployeeChannelOptions',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

None. Send "variables": {}.

Response

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

response shape
{
  "data": {
    "aiEmployeesQuery": {
      "availableMailboxes": [
        {
          "id": "<ID>",
          "emailAddress": "…",
          "provider": "…",
          "hasActiveConnection": true,
          "isSharedWithOrg": true
        }
      ],
      "availableTriggerForms": [
        {
          "id": "<ID>",
          "name": "…",
          "status": "…"
        }
      ]
    }
  }
}

Errors

Behaviour

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