List all people

Retrieve a paginated list of people (contacts/leads) in your team. People are the core entity in the CRM representing potential and existing customers.

Use Cases:

  • Build contact lists and directories
  • Export contact data to external systems
  • Sync contacts with marketing platforms
  • Generate reports on lead sources and stages
  • Filter contacts for targeted campaigns
  • Lead deduplication - find potential matches by any contact info

Filtering & Pagination:

  • Use page and limit parameters for pagination
  • Use email parameter to search by email address (partial, case-insensitive match)
  • Use phone parameter to search by phone number (flexible formatting)
  • Use stageId parameter to filter by pipeline stage (exact UUID match)
  • Use assignedUserId parameter to filter by assigned user (exact UUID match)
  • Use matchAny parameter to enable OR logic for filtering (e.g., matchAny=email,phone)
  • Use includeTrash to include soft-deleted records
  • Use includePondAccess=false with user-scoped tokens to exclude lead pond contacts
  • Default: 25 people per page, maximum 100
  • Use sort to control ordering (prefix with - for descending, e.g. -lastActivity)
  • Use firstName, lastName, or name for partial name search (drew matches Andrew)
  • Use source to filter by lead source name (comma-separated)
  • Use lastActivityAfter/lastActivityBefore for activity window filtering (ISO 8601)
  • Results default to newest-first (sort=-created)

OR Filtering (Lead Deduplication):

  • Use matchAny=email,phone to find people matching EITHER email OR phone
  • Without matchAny, multiple filters use AND logic (all must match)
  • Use case: Lead deduplication - find potential matches by any available contact info
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number (default: 1)

integer

Items per page (default: 25, max: 100)

string

Filter by email address (partial, case-insensitive match)

string

Filter by phone number (flexible formatting - digits are normalized for search)

boolean

Include soft-deleted records (default: false)

string

Enable OR logic for filtering. Comma-separated list of fields (email,phone). When provided with both email and phone params, returns people matching EITHER instead of requiring both.

string

Filter by pipeline stage ID (UUID). Returns only people in the specified stage.

string

Filter by assigned user ID (UUID). Returns only people assigned to the specified user.

string

Filter by tag name(s). Comma-separated, case-insensitive, "has ANY" semantics (a person carrying any of the listed tags is returned). Unknown tag names match nothing (empty result, no error). Maximum 50 tag names per request; exceeding returns 400.

boolean

For user-scoped tokens: when false, excludes contacts from lead ponds the user has access to, returning only directly assigned and collaborated contacts. Default: true (includes pond contacts). Has no effect on team-scoped tokens.

string

Sort field with optional direction. Prefix with '-' for descending, no prefix for ascending. Defaults to '-created' (newest first). Valid fields: id, created, updated, name, firstName, lastName, price, lastActivity, lastCommunication, lastEmail, lastCall, lastText.

string

Filter by first name — partial, case-insensitive substring match. 'drew' matches 'Andrew'.

string

Filter by last name — partial, case-insensitive substring match.

string

Filter by first name OR last name — partial, case-insensitive substring match against both fields.

string

Filter by lead source name(s). Comma-separated, case-insensitive, "has ANY" semantics. Unknown source names return empty results.

string

Return only people with last_activity_at after this datetime (exclusive). ISO 8601 format.

string

Return only people with last_activity_at before this datetime (exclusive). ISO 8601 format.

number

Filter people with price above this value (exclusive). Accepts integer or decimal.

number

Filter people with price below this value (exclusive). Accepts integer or decimal.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json