Allo

Search people

Search and filter people in your CRM with advanced filtering, sorting, and pagination.

POST/v2/api/crm/people/search

This endpoint is paginated. Use page and size in the request body to control results. See Pagination.

Request body

FieldTypeDescription
filtersobjectNamed filters (see below)
searchstringFull-text keyword search across person fields
sortstringSort order: DATE_DESC, DATE_ASC, NAME_ASC, NAME_DESC, CREATED_DESC, CREATED_ASC
pageintegerPage number (1-indexed)
sizeintegerResults per page (max 100)

Filters

Pass an object with named fields. All provided filters are combined with AND.

{
  "filters": {
    "job_title": "engineer",
    "company": "Acme"
  },
  "sort": "NAME_ASC",
  "page": 1,
  "size": 20
}

Available filter fields

FieldMatch typeDescription
namecontainsFirst name
last_namecontainsLast name
job_titlecontainsJob title
websitecontainsWebsite URL
companycontainsCompany name
phone_numberexactPhone number
emailcontainsEmail address
deal_statusexactDeal status

Custom attributes

Each result includes custom_attributes, the values of your custom fields keyed by field key. Always present, {} when there are none, with the same formats as Get person. Custom attributes cannot be used to filter or sort.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Body

filtersobject | null

Named filters. All are combined with AND.

8 fields
namestring

Filter by first name (contains)

last_namestring

Filter by last name (contains)

job_titlestring

Filter by job title (contains)

websitestring

Filter by website (contains)

companystring

Filter by company name (contains)

phone_numberstring

Filter by phone number (exact match)

emailstring

Filter by email (contains)

deal_statusstring

Filter by deal status (exact match)

searchstring | null

Free-text search across name, email, phone number, and company

sortenum<string>

Sort order (default: DATE_DESC)

DATE_DESCDATE_ASCNAME_ASCNAME_DESCCREATED_DESCCREATED_ASC

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Responses

200Search results
dataobject[]
14 fields
idstring

Unique person identifier

namestring | null

First name

last_namestring | null

Last name

job_titlestring | null

Job title

websitestring | null

Website URL

addressstring | null

Postal address

numbersstring[]

Phone numbers in E.164 format

emailsstring[]

Email addresses

companyobject | null

Embedded company reference

2 fields
idstring

Company ID

namestring

Company name

interactionsinteger

Total number of interactions (calls + messages)

last_activity_atstring<date-time> | null

Timestamp of the last activity

created_atstring<date-time>

When the person was created

updated_atstring<date-time>

When the person was last updated

custom_attributesobject

Values of the person's custom attributes, keyed by attribute key. Always present, {} when there are none. Archived attributes and empty values are omitted. NUMBER values are decimals (180 is returned as 180.0), DATE values are YYYY-MM-DD and DROPDOWN values are the option key. Create the attributes first with POST /v2/api/crm/attributes.

paginationobject
5 fields
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
401
422
429