Account API

About

Read the key owner’s profile, organization role, timezones, and permissions; update profile details; and inspect or disconnect integrations. Profile and mailbox reads use the key owner’s account; shared integrations use the key’s organization. Connecting integrations requires a human’s login in the app. 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

Reading your account (`READ` scope)

operationId	What it does
`getIntegrationSetupUrls`	In-app settings page URLs where a human connects an email account (Google/Microsoft) or sets up Twilio phone numbers for calling/SMS. Send the user the matching link to complete these flows in the app.
`getMyProfile`	Fetch the key owner’s identity, `profilePictureUrl`, `organizationRole`, `organizationMembershipStatus`, `timezone`, `resolvedTimezone`, and organization id/name/timezone. Use it to read current values before `updateMyProfile` and check the owner’s role before an `ADMIN` operation.
`getMyCapabilities`	The key owner’s own permissions — the capabilities they hold. The nine capabilities are `VIEW_ALL_CONTACTS`, `VIEW_ALL_DEALS`, `VIEW_ALL_PHONES`, `CONTRACTS_VIEW`, `CONTRACTS_MANAGE`, `CAN_SKIPTRACE`, `CAN_EXPORT`, `CAN_WORKFLOW`, and `VIEW_TEAM_DIRECTORY`. Team admins hold all nine. A missing capability is not held; an empty list means none are held, while a null list means the lookup failed and says nothing.

organizationRole is ADMIN, MEMBER, ISA, or INDEPENDENT_OPERATOR; membership status is ACTIVE or SUSPENDED. Use resolvedTimezone when interpreting times for the key owner. A null personal or organization timezone means none was chosen, not UTC; the resolved value applies the availability-schedule and organization fallbacks. For standard member/ISA seats, the three VIEW_ALL_* capabilities and CONTRACTS_VIEW/CONTRACTS_MANAGE are opt-in. The contract capabilities govern viewing and managing contracts wherever the contract surface enforces them; their presence does not add contract operations to this API. CAN_SKIPTRACE, CAN_EXPORT, and CAN_WORKFLOW are on unless revoked. VIEW_TEAM_DIRECTORY controls whether teammate identities are visible. Independent-operator seats lack it and have fixed role permissions that cannot be granted individually.

Writing your account (`WRITE` scope)

operationId	What it does
`updateMyProfile`	Update the key owner’s own profile. `firstName`, `lastName`, and `phoneNumber` are required together — send current values for fields you aren’t changing. An empty `phoneNumber` clears it; otherwise it is normalized and must be unique. Optional `profilePictureUrl` (HTTPS) and `howDidYouHearAboutUs` (free text) leave stored values untouched when omitted. Email is not editable. Returns the updated identity and `profilePictureUrl`.

Your accountThese operations act on the calling key’s own user and profile. There is no caller-supplied entity id and no cross-user access — the subject is always the key owner, derived from the key.

Integrations (`ADMIN` scope)

operationId	What it does
`listIntegrations`	Read connection status for the key owner’s mailboxes and Facebook Lead Ads, the organization’s Slack and dialers (CallTools, smrtPhone, Enzo, ReadyMode), direct-mail connections, and phone-enrichment providers. Enzo and ReadyMode include linked campaigns. Zapier, incoming webhooks, and API keys are not listed.
`disconnectSlack`	Disconnect the organization’s Slack workspace; Slack notifications stop.
`disconnectCallTools`	Revoke the CallTools key and the webhook automations Goliath created there; dispositions stop syncing.
`disconnectSmrtPhone`	Disconnect the organization’s smrtPhone dialer; its calls stop syncing.
`disconnectDialer`	Disconnect `provider: ENZO` or `READYMODE`, including every linked campaign.
`disconnectFacebookLeadAds`	Disconnect the key owner’s Facebook account. Goliath’s access is removed; Page unsubscription and Facebook deauthorization are best-effort. Inspect `pagesDisconnected` and `deauthorized`; if deauthorization failed, remove the app in Facebook settings.
`disconnectDirectMail`	Disconnect one `connectionId` from `listIntegrations`. New workflow mail sends through it are refused; mail already submitted to the provider is not cancelled.
`disconnectPhoneEnrichmentProvider`	Disconnect a `providerKey` from `phoneEnrichmentQuery.providers[].provider.key` and return its new `connectionStatus`.

Facebook Lead Ads is connected only when a returned Page has connected: true; facebookAccountConnected alone means the account is signed in. A null Page list means Facebook did not answer. Direct-mail connections report state and authHealth; phone-enrichment providers report connectionStatus.

Disconnecting stops the integrationConfirm which connection to remove before disconnecting it. Reconnecting requires the user’s login in the app; use getIntegrationSetupUrls for setup links. These operations require ADMIN, including the status read.

Example

Read the current profile:

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

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

Reading your account (`READ` scope)

Writing your account (`WRITE` scope)

Integrations (`ADMIN` scope)

Example

​About

​Operations

​Reading your account (READ scope)

​Writing your account (WRITE scope)

​Integrations (ADMIN scope)

​Example

About

Operations

Reading your account (`READ` scope)

Writing your account (`WRITE` scope)

Integrations (`ADMIN` scope)

Example