IDA API / V1

Your workspace.
Your next workflow.

Connect your tools to the context in Ida. Work with accounts, meetings, notes, and tasks through one API.

Explore the API Make your first request

REST + JSONOpenAPI 3.1202 operationsDownload specification ↓

Workspace essentials

Accounts, tasks, meetings, and the people behind them.

Explore accounts

Knowledge in context

Notes, transcripts, talk tracks, and workspace knowledge.

Explore notes

Connected workflows

Build with your connected Google Calendar, Gmail, and Gong.

Explore integrations

A SHORT PATH TO YOUR DATA

Make your first request.

Start with a personal API token, find your workspace, and read the records you need.

Authenticate

Use a personal token with the read scope. Tokens are created through the token API using browser or Google authentication. Set your token as IDA_API_TOKEN in your environment. For an interactive sign-in, use the CLI.

Find your workspace

List the workspaces your user can access. Copy a workspace ID from the response.

GET /api/v1/workspaces

curl 'https://tryida.com/api/v1/workspaces' \
  --header "Authorization: Bearer $IDA_API_TOKEN"

Read your accounts

Replace WORKSPACE_ID with your workspace ID. This request returns up to 20 accounts.

GET /api/v1/workspaces/{workspace}/accounts

curl 'https://tryida.com/api/v1/workspaces/WORKSPACE_ID/accounts?limit=20' \
  --header "Authorization: Bearer $IDA_API_TOKEN"

ACCESS THAT FOLLOWS YOUR USER

Authentication & scopes.

Send Authorization: Bearer ida_pat_… with each authenticated request. A token can access only the workspaces and operations its owner can access. Scopes further limit that access.

Scope	Permits
`read`	Retrieve data.
`write`	Create, update, and delete data.
`admin`	Additional access for administration, membership, and sharing.
`integrations`	Additional access for Google, Gong, and Hunter operations.

Tokens expire within 1–365 days and can be revoked. Connected integrations use your existing provider connections and permissions.

THE EVERYDAY DETAILS

Predictable requests.

Follow the cursor

Resource collections return data, has_more, and next_cursor. Pass the cursor as after for the next page and preserve your filters. Set limit from 1 to 500; the default is 100.

Update only what changes

PATCH preserves omitted fields. Resource creates return 201; duplicate identities return 409. Other product endpoints retain their own response shapes—check the reference for each operation.

Trace an error

Errors return an error object with code, message, and request_id. Responses also include X-Request-Id. For a 429 response, wait for the duration in Retry-After.

AT HOME IN YOUR TERMINAL

Prefer the command line?

The Ida CLI uses the same API. From the repository, install with cargo install --path cli --locked, then sign in through your browser.

TERMINAL

ida auth login
ida workspaces list
ida workspaces use WORKSPACE_ID
ida accounts list --all

Browser sign-in creates a personal token for the CLI. For an unattended integration, supply an existing token through IDA_API_TOKEN.

Find your next endpoint.Search all 202 operations and 216 schemas.

Your workspace.Your next workflow.