Contacts

Contact management operations

List all contacts

get

Returns all contacts accessible to the authenticated user

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses
chevron-right
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: +1-555-123-4567
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

get
/contacts

Create a new contact

post

Creates a new contact. Requires consultant or admin role.

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body
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
chevron-right
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: +1-555-123-4567
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

post
/contacts

List contacts for mentions

get

Returns contacts formatted for @mention functionality

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses
chevron-right
200

List of mentionable contacts

application/json
idintegerOptional
fullNamestringOptional
mentionNamestring · nullableOptional
emailstringOptional
get
/contacts/mentions

Last updated

Was this helpful?