Contacts

List contacts

integer

default:"1"

Page number

integer

default:"25"

Items per page (max 250)

string

Sort field

string

default:"desc"

Sort order: asc or desc

string

Full-text search query

string

Filter by company ID

string

Filter by tag name

GET /api/v1/contacts

Example

curl https://api.mossdesk.com/api/v1/contacts?q=acme&tag=enterprise \
  -H "X-API-Key: moss_k_..."

Get a contact

GET /api/v1/contacts/:id

Create a contact

POST /api/v1/contacts

string

required

First name

string

Last name

string

Email address

string

Phone number

string

Job title

string

LinkedIn profile URL

string

Associated company ID (UUID)

string

Free-text notes

string[]

Array of tag names

object

Custom field values as key-value pairs

Example

curl -X POST https://api.mossdesk.com/api/v1/contacts \
  -H "X-API-Key: moss_k_..." \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@acme.com",
    "title": "CTO",
    "company_id": "cmp_abc123",
    "tags": ["enterprise"]
  }'

Update a contact

PATCH /api/v1/contacts/:id

Accepts the same body fields as create. Only specified fields are updated.

Delete a contact

DELETE /api/v1/contacts/:id

Returns { "data": null } on success.

Merge contacts

Merge the source contact into the target contact. The source’s interactions, deals, follow-ups, and commitments are reassigned to the target, then the source is deleted.

POST /api/v1/contacts/merge

string

required

Source contact ID (will be deleted)

string

required

Target contact ID (will be kept)

Example

curl -X POST https://api.mossdesk.com/api/v1/contacts/merge \
  -H "X-API-Key: moss_k_..." \
  -H "Content-Type: application/json" \
  -d '{ "source_id": "cnt_abc123", "target_id": "cnt_def456" }'

Overview

CRM Resources

Views & Search

Operations

List contacts

Get a contact

Create a contact

Update a contact

Delete a contact

Merge contacts

​List contacts

​Get a contact

​Create a contact

​Update a contact

​Delete a contact

​Merge contacts

List contacts

Get a contact

Create a contact

Update a contact

Delete a contact

Merge contacts