Team API

About

Operations for the people side of your organization: list teammates, manage team invitations, change roles or suspend and restore members, read live activity counts and team performance analytics, and manage the key owner’s own profile. All operations go through the developer API gateway — one endpoint, called by operationId. If you haven’t set up a key yet, start with the Developer API Overview.

Operations

Teammates and profile (`READ` + `WRITE` scopes)

operationId	Scope	What it does
`listTeammates`	`READ`	Fuzzy-search active teammates by name, email, or phone. `limit` defaults to 20 and is capped at 50; there is no pagination and suspended members are excluded. Use the returned `userId` with `assignContact` and other operations.
`listTeamMembers`	`READ`	Page the organization’s roster, including suspended members, with `offset` and `limit` (default 50, max 100). Returns identity, `organizationRole`, `organizationMembershipStatus`, and `createdAt`. Keep paging until a short page arrives; filter status to `ACTIVE` before reporting current members.
`getTeammatesByIds`	`READ`	Resolve known teammate user ids to `id`, `firstName`, `lastName`, and `email`. Pass `userIds`; foreign-organization ids are rejected.
`getMyProfile`	`READ`	Read the key owner’s identity, profile picture, organization role and membership status, personal and resolved timezones, and organization details.
`updateMyProfile`	`WRITE`	Update the key owner’s profile. `firstName`, `lastName`, and `phoneNumber` are required together; an empty phone clears it. Optional `profilePictureUrl` and `howDidYouHearAboutUs` are partial updates. Email is not editable. See the Account API.

listTeamMembers.searchTerm matches name/email substrings, a UUID, or a complete US phone number. Partial phone numbers do not search the phone field. Without a search term, the newest members come first. Roles are ADMIN, MEMBER, ISA, and INDEPENDENT_OPERATOR; status is ACTIVE or SUSPENDED. The roster does not expose other members’ capability grants. Read the key owner’s own grants with getMyCapabilities.

Live activity counts (`READ` scope)

operationId	What it does
`countOutboundTexts`	Count outbound texts created in a time window. Returns `total`, `byUser`, and, for an organization-wide read, `otherSenders` for AI employees and workflows. `sent` counts accepted dispatches (`PENDING`, `SENT`, `DELIVERED`); `delivered` is the carrier-confirmed subset, and `failed` counts `FAILED`. Skipped sends and inbound texts are excluded.
`getTeamCallStats`	Read per-member `outboundCalls`, `inboundCalls`, `connectedCalls`, `conversationCalls`, and `talkSeconds`, plus `totals`. Counts human-handled calls; AI-handled calls and imported calls with no member are excluded.

Both require startDate (inclusive) and endDate (exclusive), as ISO datetimes with an offset. Resolve calendar dates in getMyProfile.resolvedTimezone before calling. Windows are limited to 93 calendar days; split a longer range. These are live reads, separate from the nightly analytics below, and do not charge the analytics rate-limit bucket. Without userIds, a key owner holding VIEW_ALL_PHONES gets the organization-wide result; otherwise only their own activity is returned. With that capability, userIds narrows the read to named members and countOutboundTexts.otherSenders is null. Naming a teammate without the capability is refused. Named members appear even when their counts are zero. Member text counts exclude AI-employee and workflow sends even when those use the member’s line. For calls, connectedCalls means status COMPLETED; conversationCalls requires a connected call lasting at least 120 seconds or having a transcript or AI summary. talkSeconds sums connected-call durations, using zero when duration is missing. These human-only counts can be lower than the nightly analytics, which can credit AI-handled calls to a member.

Team members (`ADMIN` scope)

operationId	What it does
`changeTeamMemberRole`	Change a `userId` from `listTeamMembers` to `role: ADMIN`, `MEMBER`, `ISA`, or `INDEPENDENT_OPERATOR`, effective immediately. Moving to independent operator drops team memberships and permission grants. A change leaving no active admin is refused.
`removeTeamMember`	Suspend a teammate, removing access and freeing their seat; optionally record a `reason`. Their open tasks go to the key owner, contact point-person seats are released, and workflow-step and lead-routing assignments are removed. Self-removal is refused.
`restoreTeamMember`	Restore a suspended teammate’s access and seat, subject to the organization’s seat policy. An already-active member is unchanged. Handed-over work stays where it went.

Review the handover before removing a memberRemoval changes assignments as well as access, and restoration does not reverse those changes. Inspect the removal result’s handover, reassignedTaskCount, releasedContactSeatCount, handedOverContactCount, openWorkTruncated, and openWorkFailed to identify work left behind. Suspended members remain visible in listTeamMembers.

Team invites (`ADMIN` scope)

operationId	What it does
`listTeamInvites`	List the organization’s team invitations (pending + spent/revoked, single-use + permanent). Each `id` maps to the accept URL `/accept-invite/{id}`.
`createTeamInvite`	Create an invite link. `userType` sets the role (`ADMIN`, `MEMBER`, `ISA`, or `INDEPENDENT_OPERATOR`; default `MEMBER`). Independent-operator invites require that seat to be enabled for the organization, checked again on acceptance. Pass `emails` to notify recipients, or `isPermanent: true` for a reusable link; newly created permanent links use the `MEMBER` role.
`revokeTeamInvite`	Revoke an invitation by id — the link stops working immediately.
`resendTeamInvite`	Re-send a live invitation’s email using `invitationId`. Keeps the same invitation and accept URL. Spent, revoked, or permanent invitations are refused; use `emailPermanentTeamInvite` for a reusable link.
`emailPermanentTeamInvite`	Email the organization’s existing permanent invite link to 1–50 `emails`. Normalized duplicates are sent once. Create the reusable link first with `createTeamInvite(isPermanent: true)`; this operation does not create one.

Team analytics (`ADMIN` scope)

Reporting reads over the same nightly snapshots as the web app’s Analytics pages — each response carries the asOfDate it was computed. Both take an optional period: SEVEN_DAYS | FOURTEEN_DAYS | THIRTY_DAYS | YEAR_TO_DATE (default THIRTY_DAYS). The schema also lists SIXTY_DAYS and THIS_MONTH, but these analytics operations reject them with BAD_USER_INPUT.

operationId	What it does
`getTeamAnalyticsOverview`	Team performance overview — org-wide activity totals with prior-period deltas, per-agent rows (calls, texts, appointments, lead buckets, score), and per-agent pipeline outcomes.
`getTeamActivityTimeseries`	Daily team activity rows — calls, texts, emails, tasks, appointments, active agents, new leads per day. For charting trends.

Rate-limitedThe nightly analytics operations above are rate-limited per key. Exceeding the limit returns 429 rate_limited with a Retry-After header. Pipeline-level analytics (outcomes and funnel) live in the Pipelines API.

Everything is your organizationTeam operations are inherently org-scoped: listTeammates and listTeamInvites return only your organization’s people and invites, and createTeamInvite creates under your org. revokeTeamInvite takes an invitation id, but a foreign one is rejected — the service requires you to be an ADMIN of that invitation’s own organization. Analytics run against your org only (the gateway injects the org id, so it can’t be forged). See Authorization.

Example

Pull the last 7 days of team activity for a dashboard:

curl -X POST https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer gsk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "operationId": "getTeamActivityTimeseries", "variables": { "period": "SEVEN_DAYS" } }'

Full variable schemas, response shapes, and worked examples for every operation are available from the discovery endpoint.

Getting Started

TypeScript SDK

Core Resources

Automations

Communication & Tasks

Account & Billing

About

Operations

Teammates and profile (`READ` + `WRITE` scopes)

Live activity counts (`READ` scope)

Team members (`ADMIN` scope)

Team invites (`ADMIN` scope)

Team analytics (`ADMIN` scope)

Example

​About

​Operations

​Teammates and profile (READ + WRITE scopes)

​Live activity counts (READ scope)

​Team members (ADMIN scope)

​Team invites (ADMIN scope)

​Team analytics (ADMIN scope)

​Example

About

Operations

Teammates and profile (`READ` + `WRITE` scopes)

Live activity counts (`READ` scope)

Team members (`ADMIN` scope)

Team invites (`ADMIN` scope)

Team analytics (`ADMIN` scope)

Example