GoliathDevelopersGet an API key
Reference/Teamgenerated from the gateway manifest

getTeammatesByIds

Resolve teammate USER IDS to names.

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

Resolve teammate USER IDS to names: pass userIds, get back id, firstName, lastName, email for each. This is the id → person lookup, and the ONLY one: listTeammates searches names, emails and phone numbers and returns at most 50 rows, so it cannot answer "who is <uuid>" in an organization larger than that. Reach for this whenever you are about to REPORT a bare user id to someone (a filter's userId, a task's participants, a note author) because "owned by 4f3c…" is not an answer a person can act on. Ids outside your organization are rejected; nothing here reveals a user in another org.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getTeammatesByIds",
    "variables": {
      "userIds": [
        "<userIds>"
      ]
    }
  }'
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.team.getTeammatesByIds({
  userIds: [
    '<userIds>'
  ]
})
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: 'getTeammatesByIds',
    variables: {
      userIds: [
        '<userIds>'
      ]
    }
  }),
})
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.

userIds[ID!]!required

Response

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

response shape
{
  "data": {
    "teamQuery": {
      "getTeamMembersByIds": [
        {
          "id": "<ID>",
          "firstName": "…",
          "lastName": "…",
          "email": "…"
        }
      ]
    }
  }
}

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.

READlistTeammatesREADlistTeamMembersREADcountOutboundTextsREADgetTeamCallStatsREADgetMemberActivityADMINlistTeamInvites