Contacts

Contact management operations

List all contacts

get

Returns all contacts accessible to the authenticated user

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses

200

List of contacts

application/json

idintegerRequired

Unique contact identifier

Example: 1

fullNamestringRequired

Contact's full name

Example: Jane Smith

mentionNamestring · nullableOptional

Short name for @mentions

Example: jsmith

emailstring · emailRequired

Contact email address

Example: [email protected]

phonestring · nullableOptional

Contact phone number

Example: [phone]

companystring · nullableOptional

Company name

Example: Acme Corp

titlestring · nullableOptional

Job title

Example: VP of Sales

departmentstring · nullableOptional

Department

Example: Sales

typestring · enumRequired

Contact type

Example: clientPossible values:

isActivebooleanRequired

Whether the contact is active

Example: true

metadataobject · nullableOptional

Additional contact metadata

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Access denied

500

Server error

get

/contacts

HTTPcURLJavaScriptPython

GET /api/contacts HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "fullName": "Jane Smith",
    "mentionName": "jsmith",
    "email": "[email protected]",
    "phone": "[phone]",
    "company": "Acme Corp",
    "title": "VP of Sales",
    "department": "Sales",
    "type": "client",
    "isActive": true,
    "metadata": {},
    "createdAt": "2026-03-18T11:44:51.786Z",
    "updatedAt": "2026-03-18T11:44:51.786Z"
  }
]

Create a new contact

post

Creates a new contact. Requires consultant or admin role.

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body

application/json

fullNamestringRequired

Contact's full name

Example: John Doe

mentionNamestring · nullableOptional

Short name for @mentions

emailstring · emailRequired

Contact email address (must be unique)

Example: [email protected]

phonestring · nullableOptional

Contact phone number

companystring · nullableOptional

Company name

titlestring · nullableOptional

Job title

departmentstring · nullableOptional

Department

typestring · enumRequiredExample: externalPossible values:

isActivebooleanOptionalDefault: true

metadataobject · nullableOptional

canLoginbooleanOptional

Whether to create a user account for this contact

Default: false

Responses

200

Contact created successfully

application/json

idintegerRequired

Unique contact identifier

Example: 1

fullNamestringRequired

Contact's full name

Example: Jane Smith

mentionNamestring · nullableOptional

Short name for @mentions

Example: jsmith

emailstring · emailRequired

Contact email address

Example: [email protected]

phonestring · nullableOptional

Contact phone number

Example: [phone]

companystring · nullableOptional

Company name

Example: Acme Corp

titlestring · nullableOptional

Job title

Example: VP of Sales

departmentstring · nullableOptional

Department

Example: Sales

typestring · enumRequired

Contact type

Example: clientPossible values:

isActivebooleanRequired

Whether the contact is active

Example: true

metadataobject · nullableOptional

Additional contact metadata

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

400

Validation error or email already exists

401

Not authenticated

403

Permission denied

500

Server error

post

/contacts

HTTPcURLJavaScriptPython

POST /api/contacts HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 207

{
  "fullName": "John Doe",
  "mentionName": "text",
  "email": "[email protected]",
  "phone": "text",
  "company": "text",
  "title": "text",
  "department": "text",
  "type": "external",
  "isActive": true,
  "metadata": {},
  "canLogin": false
}

{
  "id": 1,
  "fullName": "Jane Smith",
  "mentionName": "jsmith",
  "email": "[email protected]",
  "phone": "[phone]",
  "company": "Acme Corp",
  "title": "VP of Sales",
  "department": "Sales",
  "type": "client",
  "isActive": true,
  "metadata": {},
  "createdAt": "2026-03-18T11:44:51.786Z",
  "updatedAt": "2026-03-18T11:44:51.786Z"
}

List contacts for mentions

get

Returns contacts formatted for @mention functionality

Authorizations

sessionAuth

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses

200

List of mentionable contacts

application/json

idintegerOptional

fullNamestringOptional

mentionNamestring · nullableOptional

emailstringOptional

401

Not authenticated

500

Server error

get

/contacts/mentions

HTTPcURLJavaScriptPython

GET /api/contacts/mentions HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "fullName": "text",
    "mentionName": "text",
    "email": "text"
  }
]