Account API

About

Read and update the profile of the user who owns the API key — name, email, and phone number — and get the in-app links a human uses to connect email or set up phone/Twilio. Everything here operates on the calling key’s own account; there are no cross-user ids. 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 own profile — name, email, and phone number. Use it to read current values before `updateMyProfile`.
`getMyCapabilities`	The key owner’s own permissions — the capabilities they hold (a missing one is one they do not have). Six exist: three opt-in, off unless a team admin granted them (`VIEW_ALL_CONTACTS`, `VIEW_ALL_DEALS`, `VIEW_ALL_PHONES`), and three opt-out, on unless revoked (`CAN_SKIPTRACE`, `CAN_EXPORT`, `CAN_WORKFLOW`). Team admins hold all six. Check this before attempting a gated action; an empty list means none are held, while a null list means the lookup failed and says nothing.

Writing your account (`WRITE` scope)

operationId	What it does
`updateMyProfile`	Update the key owner’s own profile. `firstName`, `lastName`, and `phoneNumber` are all required together — send the current values for fields you aren’t changing (read them with `getMyProfile`). Phone is normalized and must be unique; email is not editable here. Returns the updated profile.

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.

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)

Example

​About

​Operations

​Reading your account (READ scope)

​Writing your account (WRITE scope)

​Example

About

Operations

Reading your account (`READ` scope)

Writing your account (`WRITE` scope)

Example