Workspace API

Endpoints

Workspace API operations for accounts, projects, contacts, Views, Favorites, Skills, and workspace meta reads.

Ordinary account, contact, and project searches remain your book. Broader Dynamic/Static View execution uses POST /workspace/views/{id}/records/search. See Workspace Views. Skills use the action-named /workspace/skills/* family. See Workspace Skills.

Workspace meta reads return plan and usage information for the calling workspace. They cost 0 credits and never throttle.

Operation	Method + path	Credits
Get workspace info	`GET /workspace`	0
Get credits	`GET /workspace/credits`	0

The Workspace API also exposes four operations for each of its three datasets: accounts, projects, and contacts. Two are reads and two are writes. All share the { data, metadata } response envelope.

Operation	Method + path	Credits
Search accounts	`POST /workspace/accounts/search`	1 per row returned
Get an account	`GET /workspace/accounts/{id}`	1 per call
Upsert account	`POST /workspace/accounts/upsert`	0
Delete account	`DELETE /workspace/accounts/{id}`	0
Batch upsert accounts	`POST /workspace/accounts/upsert/batch`	0
Batch delete accounts	`POST /workspace/accounts/delete/batch`	0
Search projects	`POST /workspace/projects/search`	1 per row returned
Get a project	`GET /workspace/projects/{id}`	1 per call
Upsert project	`POST /workspace/projects/upsert`	0
Delete project	`DELETE /workspace/projects/{id}`	0
Batch upsert projects	`POST /workspace/projects/upsert/batch`	0
Batch delete projects	`POST /workspace/projects/delete/batch`	0
Search contacts	`POST /workspace/contacts/search`	1 per row returned
Get a contact	`GET /workspace/contacts/{id}`	1 per call
Upsert contact	`POST /workspace/contacts/upsert`	0
Delete contact	`DELETE /workspace/contacts/{id}`	0
Batch upsert contacts	`POST /workspace/contacts/upsert/batch`	0
Batch delete contacts	`POST /workspace/contacts/delete/batch`	0

Shared Views and personal Favorites:

Operation	Method + path	Credits
List Views	`GET /workspace/views`	0
Get a View	`GET /workspace/views/{id}`	0
Upsert View	`POST /workspace/views/upsert`	0
Batch upsert Views	`POST /workspace/views/upsert/batch`	0
Delete a View	`DELETE /workspace/views/{id}`	0
Batch delete Views	`POST /workspace/views/delete/batch`	0
Add View records	`POST /workspace/views/{id}/records/add`	0
Batch add View records	`POST /workspace/views/{id}/records/add/batch`	0
Remove a View record	`DELETE /workspace/views/{id}/records/{recordId}`	0
Batch remove View records	`POST /workspace/views/{id}/records/delete/batch`	0
Search View records	`POST /workspace/views/{id}/records/search`	1 per row returned
List Favorite Views	`GET /workspace/favorite-views`	0 (user JWT)
Upsert Favorite View	`POST /workspace/favorite-views/upsert`	0 (user JWT)
Batch upsert Favorites	`POST /workspace/favorite-views/upsert/batch`	0 (user JWT)
Delete a Favorite	`DELETE /workspace/favorite-views/{viewId}`	0 (user JWT)
Batch delete Favorites	`POST /workspace/favorite-views/delete/batch`	0 (user JWT)

Batch writes accept 1-100 records per call and return per-item results in input order. One record failing never aborts the rest. See Batch writes for the shared request and response shapes.

Skills are portable instruction bundles. Every Skills route costs 0 credits. Reads return { data, metadata: { credits: 0 } }. Writes return a content-free receipt. Each write has a /batch sibling.

Operation	Method + path	Credits
Find skills	`POST /workspace/skills/find`	0
List skills	`POST /workspace/skills/list`	0
Get a skill	`POST /workspace/skills/get`	0
Get a skill file	`POST /workspace/skills/get-file`	0
List skill revisions	`POST /workspace/skills/revisions`	0
Create a skill	`POST /workspace/skills/create`	0
Batch create skills	`POST /workspace/skills/create/batch`	0
Update a skill draft	`POST /workspace/skills/update`	0
Batch update skill drafts	`POST /workspace/skills/update/batch`	0
Publish a skill	`POST /workspace/skills/publish`	0
Batch publish skills	`POST /workspace/skills/publish/batch`	0
Unpublish a skill	`POST /workspace/skills/unpublish`	0
Batch unpublish skills	`POST /workspace/skills/unpublish/batch`	0
Delete a skill	`POST /workspace/skills/delete`	0
Batch delete skills	`POST /workspace/skills/delete/batch`	0
Transfer a skill	`POST /workspace/skills/transfer`	0
Batch transfer skills	`POST /workspace/skills/transfer/batch`	0
Move a skill	`POST /workspace/skills/move`	0
Batch move skills	`POST /workspace/skills/move/batch`	0
Fork a skill	`POST /workspace/skills/fork`	0
Batch fork skills	`POST /workspace/skills/fork/batch`	0
Install an official skill	`POST /workspace/skills/install`	0
Batch install official skills	`POST /workspace/skills/install/batch`	0
Uninstall an official skill	`POST /workspace/skills/uninstall`	0
Batch uninstall official skills	`POST /workspace/skills/uninstall/batch`	0

Signal subscriptions are workspace configuration, not a dataset. They control which signal types the workspace tracks and how alerts are delivered.

Operation	Method + path	Credits
List subscriptions	`GET /workspace/signal-subscriptions`	0
Upsert subscription	`POST /workspace/signal-subscriptions/upsert`	0
Delete subscription	`DELETE /workspace/signal-subscriptions/{id}`	0

Members and invitations are workspace administration, not a dataset. They let you inspect and manage who has access to the workspace and invite new team members.

Operation	Method + path	Credits
List members	`GET /workspace/members`	0
Update a member	`PATCH /workspace/members/{userId}`	0
Remove a member	`DELETE /workspace/members/{userId}`	0
Invite a user	`POST /workspace/invitations`	0
List invitations	`GET /workspace/invitations`	0
Revoke an invitation	`DELETE /workspace/invitations/{id}`	0

Shared response envelope

Every response wraps its payload in a { data, metadata } envelope, matching the Data API shape. Search responses include pagination fields; get, upsert, and delete responses include only credits.

Upsert match rules

Upsert endpoints accept either an explicit UUID or a natural-key match to identify the target record. The available match strategies differ by entity:

Accounts accept account_id (UUID) or match: { domain }.
Contacts accept contact_id (UUID) or match: { email }.
Projects accept project_id (UUID) only. Projects have no natural key.

When using a natural-key match (domain for accounts, email for contacts):

Matches	Result
Exactly 1 record	Upsert proceeds
0 records	`404 not_found`
More than 1 record	`409 ambiguous_match` (use the explicit UUID instead)

Partial update semantics

Upsert applies partial updates to your workspace’s custom fields:

Omitted fields are left unchanged. You can update workspace_status without touching notes or tags.
Explicit null clears a field. Sending "notes": null removes the existing note.
tags is full-replace. Sending "tags": ["boston"] replaces the entire tag set. To clear all tags, send "tags": [].

Metering

Book entity searches and gets, plus View-record search, cost 1 credit per row returned or record fetched. View definition reads (list/get Views), Favorite reads and writes, View upsert/delete, membership add/remove, book upserts/deletes, and every Skills route cost 0 credits. Credits roll over a 24-hour window with a ceiling of 250,000 per Pro workspace. See Credits.

Get Workspace InfoReturn the workspace plan, entitlements, seat usage, and settings object.Get CreditsReturn credit usage and remaining capacity for the rolling 24-hour window.Search AccountsPOST body reference: filters, sort, limit, offset, and search_after.Get an AccountFetch one workspace account by UUID, with optional related-record includes.Upsert AccountAdd or update a workspace account by account id or domain match.Delete an AccountRemove your workspace’s custom data for an account. Idempotent.Search ProjectsPOST body reference: filters, sort, limit, offset, and search_after.Get a ProjectFetch one workspace project by UUID, with optional related-record includes.Upsert ProjectAdd or update a workspace project by project id.Delete a ProjectRemove your workspace’s custom data for a project. Idempotent.Search ContactsPOST body reference: filters, sort, limit, offset, and search_after.Get a ContactFetch one workspace contact by UUID, with optional related-record includes.Upsert ContactAdd or update a workspace contact by contact id or email match.Delete a ContactRemove your workspace’s custom data for a contact. Idempotent.Manage ViewsList, fetch, create, update, and delete shared Dynamic and Static Views.View RecordsAdd, remove, and search the records a View exposes.List SubscriptionsReturn all signal types the workspace tracks, with priorities, channels, and new-signal counts.Upsert SubscriptionSubscribe to a signal type or update its priority, channels, recipients, and cadence.Delete a SubscriptionRemove a signal subscription by its row id. Idempotent.List MembersReturn all workspace members with their role and join date.Update a MemberChange a member’s role to owner, admin, or member.Remove a MemberRemove a user from the workspace. Idempotent.Invite a UserCreate an invitation for an email address and dispatch the invite email.List InvitationsReturn all pending and expired invitations for the workspace.Revoke an InvitationRevoke a pending invitation by id. Returns 404 if already accepted or revoked.