Axiomatic Docs

CRM HTTP API — read:crm / write:crm scopes. Send Authorization: Bearer ak_... and entityId (query or JSON body). Browser sessions may use x-entity-id instead of Bearer.

Add companies to a marketing list

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

listId*string

Formatuuid

companyIds?array<>

filter?

Response Body

`application/json`

curl -X POST "https://example.com/api/crm/prospecting/add-to-marketing-list?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "listId": "9fc6ad7d-902a-4834-b161-a4911b883d44"  }'

Empty

{
  "error": "string"
}

{
  "error": "string"
}

Empty

CRM dashboard aggregates

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/dashboard?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{}

{
  "error": "string"
}

List companies

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

role?string

Commercial relationship type

Value in"prospect" | "customer" | "vendor" | "both"

status?string

Lifecycle: active or archived

Value in"active" | "inactive"

ownerUserId?string

UUID, me, or unassigned

q?string

Search name (ilike)

page?integer

Range1 <= value

pageSize?integer

limit?integer

Legacy: caps page size when page omitted

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/companies?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{}

{
  "error": "string"
}

Create company

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

legalName?string

website?string

industry?string

notes?string

role?string

Commercial relationship; defaults to prospect

Value in"prospect" | "customer" | "vendor" | "both"

status?string

Lifecycle; defaults to active

Value in"active" | "inactive"

ownerUserId?string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/crm/companies?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{}

{
  "error": "string"
}

{
  "error": "string"
}

Get company by ID

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

companyId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{}

{
  "error": "string"
}

{
  "error": "string"
}

Update company

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

companyId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

legalName?string

website?string

industry?string

notes?string

role?string

Value in"prospect" | "customer" | "vendor" | "both"

status?string

Value in"active" | "inactive"

ownerUserId?string

Formatuuid

metadata?

Response Body

`application/json`

curl -X PATCH "https://example.com/api/crm/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

{
  "error": "string"
}

List contacts linked to a company

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

companyId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/contacts?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

{
  "error": "string"
}

List contacts

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

companyId?string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/contacts?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

Create contact

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

displayName?string

firstName?string

lastName?string

jobTitle?string

department?string

email?string

Formatemail

phone?string

notes?string

companyId?string

Formatuuid

primaryCompany?boolean

source?string

Value in"manual" | "platform_resolved" | "imported"

metadata?object

Response Body

`application/json`

curl -X POST "https://example.com/api/crm/contacts?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

Empty

Get contact

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

contactId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

{
  "error": "string"
}

Update contact

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

contactId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

displayName?string

status?string

Value in"active" | "archived"

firstName?string

lastName?string

jobTitle?string

department?string

email?string

phone?string

notes?string

replaceMetadata?object

metadata?object

Response Body

`application/json`

curl -X PATCH "https://example.com/api/crm/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

Delete contact (not supported)

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

contactId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X DELETE "https://example.com/api/crm/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

List company memberships for a contact

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

contactId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/company-memberships?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

Add contact–company membership

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

contactId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

companyId*string

Formatuuid

title?string

isPrimary?boolean

startDate?string

endDate?string

notes?string

Response Body

curl -X POST "https://example.com/api/crm/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/company-memberships?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda"  }'

Empty

Update membership

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

contactId*string

Formatuuid

membershipId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

companyId?string

Formatuuid

title?string

isPrimary?boolean

startDate?string

endDate?string

notes?string

Response Body

`application/json`

curl -X PATCH "https://example.com/api/crm/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/company-memberships/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

Remove membership

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

contactId*string

Formatuuid

membershipId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/crm/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/company-memberships/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

List CRM pipeline stages

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/pipeline-stages?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "stages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "kind": "open",
      "sortOrder": 0,
      "defaultProbabilityPct": 0,
      "colorKey": "string",
      "systemKey": "string",
      "leadCount": 0
    }
  ]
}

{
  "error": "string"
}

Create open pipeline stage

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

defaultProbabilityPct?integer

Range0 <= value <= 100

colorKey?string

Response Body

`application/json`

curl -X POST "https://example.com/api/crm/pipeline-stages?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

Empty

{
  "error": "string"
}

{
  "error": "string"
}

Reorder pipeline stages

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

stageIds*array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/crm/pipeline-stages/reorder?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "stageIds": [      "ef8acdf2-9c60-4264-8296-0d97712d5691"    ]  }'

Empty

{
  "error": "string"
}

{
  "error": "string"
}

Update pipeline stage

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

stageId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

defaultProbabilityPct?integer

Range0 <= value <= 100

colorKey?string

Response Body

`application/json`

curl -X PATCH "https://example.com/api/crm/pipeline-stages/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Delete open pipeline stage

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

stageId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

moveToStageId?string

Required when stage has leads

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/crm/pipeline-stages/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

List leads

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

companyId?string

Formatuuid

contactId?string

Formatuuid

stageId?string

Formatuuid

stage?string

Filter by stage name or legacy system key

Response Body

curl -X GET "https://example.com/api/crm/leads?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Create lead

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

stageId?string

Pipeline stage id; defaults to first open stage

Formatuuid

stage?string

Legacy alias — resolved against stage name or system key

expectedValue?string

currency?string

notes?string

companyId?string

Formatuuid

contactId?string

Formatuuid

Response Body

curl -X POST "https://example.com/api/crm/leads?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "title": "string"  }'

Empty

Get lead

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

leadId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

Update lead

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

leadId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

stageId?string

Formatuuid

stage?string

Legacy alias — resolved against stage name or system key

title?string

expectedValue?string

currency?string

notes?string

companyId?string

Formatuuid

contactId?string

Formatuuid

Response Body

`application/json`

curl -X PATCH "https://example.com/api/crm/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

Delete lead

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

leadId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/api/crm/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

Lead activity timeline

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

leadId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/api/crm/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/timeline?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "error": "string"
}

Move lead stage (win/loss automation)

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

leadId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

stageId?string

Target pipeline stage id

Formatuuid

stage?string

Legacy alias — resolved against stage name or system key

probability?number

lostReason?string

skipAutomation?boolean

When winning, skip quote/project creation

Response Body

`application/json`

curl -X PATCH "https://example.com/api/crm/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/stage?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{
  "error": "string"
}

Add activity on a lead

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

leadId*string

Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

subject*string

body?string

dueAt?string

Response Body

`application/json`

curl -X POST "https://example.com/api/crm/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/activities?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "type": "call",    "subject": "string"  }'

Empty

{
  "error": "string"
}

List CRM activities

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

companyId?string

Formatuuid

contactId?string

Formatuuid

Response Body

curl -X GET "https://example.com/api/crm/activities?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Create activity

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

subject*string

body?string

leadId?string

companyId?string

contactId?string

dueAt?string

Response Body

curl -X POST "https://example.com/api/crm/activities?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "type": "call",    "subject": "string"  }'

Empty

List project tasks (CRM shell)

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

projectId?string

Formatuuid

status?string

Response Body

curl -X GET "https://example.com/api/crm/tasks?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Send outbound email for a lead

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

leadId*string

Formatuuid

connectionId*string

Formatuuid

channel*string

Value in"gmail" | "resend_email"

subject*string

htmlBody*string

textBody?string

Response Body

`application/json`

curl -X POST "https://example.com/api/crm/outbound-email?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "leadId": "3c6e2b8e-0e8f-48db-8791-27271df10113",    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",    "channel": "gmail",    "subject": "string",    "htmlBody": "string"  }'

Empty

{
  "error": "string"
}

List outbound email connections

Authorization

bearerAuth

AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X GET "https://example.com/api/crm/outbound-email-connections?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

CRM

200

400application/json

401application/json

403

404

200application/json

401application/json

200application/json

401application/json

201application/json

400application/json

401application/json

200application/json

401application/json

404application/json

200

401application/json

404application/json

200

401application/json

404application/json

200

401application/json

201

401application/json

404

200

401application/json

404application/json

200

404application/json

410

200

404application/json

201

404

200

404application/json

200

404application/json

200application/json

401application/json

201

400application/json

401application/json

200

400application/json

401application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`