Records API - API Reference

The Records API is the primary way to read and write CRM data. Query, create, update, and delete records across any object in your organization.

Query Records

Retrieve records with optional filtering, sorting, and pagination:

GET /api/crm/records/query?object_id=obj_contacts&page=1&per_page=25

# With filters
GET /api/crm/records/query?object_id=obj_contacts&filters={"status":"active"}

# With sorting
GET /api/crm/records/query?object_id=obj_contacts&sort=created_at&order=desc

Query Parameters

Parameter	Type	Description
`object_id`	string	Required. The object to query
`filters`	JSON	Field filters (see Filter Syntax below)
`sort`	string	Field to sort by
`order`	string	"asc" or "desc" (default: "asc")
`page`	number	Page number (default: 1)
`per_page`	number	Results per page (default: 25, max: 100)

Filter Syntax

{
  // Exact match
  "status": "active",

  // Comparison operators
  "deal_value": { "$gte": 10000 },
  "created_at": { "$lt": "2024-01-01" },

  // Multiple conditions (AND)
  "status": "active",
  "source": "website",

  // Contains (text search)
  "name": { "$contains": "John" },

  // In array
  "category": { "$in": ["Enterprise", "SMB"] },

  // Is empty / not empty
  "phone": { "$empty": false }
}

Get Single Record

GET /api/crm/record/{record_id}

Create Record

POST /api/crm/record
Content-Type: application/json

{
  "object_id": "obj_contacts",
  "field_values": {
    "name": "Jane Smith",
    "email": "jane@example.com",
    "phone": "+1 (555) 987-6543",
    "status": "new",
    "source": "api"
  }
}

Update Record

PATCH /api/crm/record/{record_id}
Content-Type: application/json

{
  "field_values": {
    "status": "qualified",
    "notes": "Spoke on phone, interested in the larger package"
  }
}

Delete Record

DELETE /api/crm/record/{record_id}

Batch Operations

For bulk work, create records with POST /api/crm/records/batch and update them with PATCH /api/crm/records/batch, or use the CSV/Excel import. See Rate Limits for the request limits.

Next Steps

Objects API — Manage your schema
Fields API — Configure field definitions
Webhooks — Get notified on record changes