curl -X GET "https://api.nedzo.ai/v1/contacts?workspaceId=789e4567-e89b-12d3-a456-426614174000&limit=100&offset=0" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"phone": "+14155551234",
"timezone": "America/Los_Angeles",
"tags": ["newsletter", "vip"],
"dnd": false,
"customFields": {
"Lead Source": "Website",
"MRR": "250"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
],
"total": 2450,
"limit": 100,
"offset": 0,
"hasMore": true
}
Contacts
List contacts
Page through the contacts in a workspace via the Nedzo REST API, up to 1,000 per page.
GET
/
contacts
curl -X GET "https://api.nedzo.ai/v1/contacts?workspaceId=789e4567-e89b-12d3-a456-426614174000&limit=100&offset=0" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"phone": "+14155551234",
"timezone": "America/Los_Angeles",
"tags": ["newsletter", "vip"],
"dnd": false,
"customFields": {
"Lead Source": "Website",
"MRR": "250"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
],
"total": 2450,
"limit": 100,
"offset": 0,
"hasMore": true
}
workspaceId is required for account-scoped API keys and inferred from the key for workspace-scoped keys. See Workspace ID and Request Scope.Changed in October 2026: this endpoint returns one page as an object,
{ items, total, limit, offset, hasMore }. It used to return a bare array of at most 1,000 contacts. Read the contacts from items.string
Workspace UUID (required for account API keys, optional for workspace API keys)
string
Only contacts with this tag, by name
string
Match first name, last name, email or phone (contains, not case-sensitive)
string
Created at or after this time (ISO 8601, for example
2026-10-01T00:00:00Z). Also createdBefore, updatedAfter and updatedBefore.integer
default:"100"
Contacts per page, from 1 to 1000
integer
default:"0"
How many contacts to skip, up to 10,000,000. Contacts come oldest first, so add
limit to offset for the next page while hasMore is true.curl -X GET "https://api.nedzo.ai/v1/contacts?workspaceId=789e4567-e89b-12d3-a456-426614174000&limit=100&offset=0" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspaceId": "789e4567-e89b-12d3-a456-426614174000",
"firstName": "John",
"lastName": "Doe",
"email": "john@example.com",
"phone": "+14155551234",
"timezone": "America/Los_Angeles",
"tags": ["newsletter", "vip"],
"dnd": false,
"customFields": {
"Lead Source": "Website",
"MRR": "250"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
],
"total": 2450,
"limit": 100,
"offset": 0,
"hasMore": true
}
Was this page helpful?
