Skip to main content
GET
Search entity lists (named collections of companies or persons) by name.

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

Page number, 1-indexed. Clamped to >= 1.

per_page
integer
default:50

Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).

name
string | null

Exact (case-sensitive) name match.

search
string | null

Case-insensitive substring search on name.

kind
enum<string> | null

Filter by list kind.

Available options:
PERSON,
COMPANY,
NOTE,
ACTIVITY,
FILE,
TASK,
OPPORTUNITY

Response

200 - application/json

Paginated list of entity lists.

items
EntityListResponseItem · object[]
required
page
integer
required
per_page
integer
required
total
integer
required