Skip to main content

​
List contacts

​
page
integer
default:"1"
Page number
​
per_page
integer
default:"25"
Items per page (max 250)
​
sort
string
Sort field
​
order
string
default:"desc"
Sort order: asc or desc
​
q
string
Full-text search query
​
company_id
string
Filter by company ID
​
tag
string
Filter by tag name
GET /api/v1/contacts
Example
curl https://api.mosscrm.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
​
first_name
string
required
First name
​
last_name
string
Last name
​
email
string
Email address
​
phone
string
Phone number
​
title
string
Job title
​
linkedin_url
string
LinkedIn profile URL
​
company_id
string
Associated company ID (UUID)
​
notes
string
Free-text notes
​
tags
string[]
Array of tag names
​
custom_fields
object
Custom field values as key-value pairs
Example
curl -X POST https://api.mosscrm.com/api/v1/contacts \
  -H "X-API-Key: moss_k_..." \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "[email protected]",
    "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
​
source_id
string
required
Source contact ID (will be deleted)
​
target_id
string
required
Target contact ID (will be kept)
Example
curl -X POST https://api.mosscrm.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" }'