Skip to main content
The Relate Public API lets you work with your workspace’s CRM data — contacts, organizations, notes, deals, lists, and more — programmatically.

​
Base URL

All endpoints are relative to the following base URL. 
https://api.relate.so/v1

​
Authorization

Every request must include your API key as a Bearer token in the Authorization header. 
curl https://api.relate.so/v1/.. \
  -H "Authorization: Bearer {API key}"
An API key is a secret that can access your workspace data. Keep it from being exposed.

​
Getting an API key

For API key issuance, pricing, and usage questions, please reach out to the Relate team at we@relate.so or via in-app chat.

​
Pagination

All “list” API methods support offset-based pagination through the first and after parameters. For example, to get 30 items after the 20th, include ?first=30&after=20 in the request. If omitted, first defaults to 25 and after to 0. List response format: 
{
  "data": [...],
  "pagination": {
    "end_cursor": 25,
    "has_next_page": true,
    "total_count": 123
  }
}
Resources in "data" are sorted by updated_at timestamp (unless otherwise noted), with the most recently updated resources appearing first.

​
Filtering updated resources

All “list” API methods also support filtering resources updated since a given timestamp. Include ?updated_after={unix timestamp} in the request.