Get a paginated list of address book entries

Scope: read:address-book

Sorted by company name unless order says otherwise. clientId narrows the list to one
agency, and teamId to the agency an office belongs to (the address book is the agency's,
not the office's). They only narrow what the API key can already see: one outside its
scope answers 403, whether it exists or not.

category can be repeated, and each value must be on the list from
GET /v2/reference/address-book-categories.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
0 to 2147483647
int32
1 to 100

Part of the company name, or of the contact's name.

Category
array of strings

Only entries in these categories. Repeat it for more than one
(?category=Plumber&category=Electrician). Each must be on the category list.

Category
uuid

Only this agency's entries. An agency outside the API key's scope answers 403.

uuid

Only the entries of this office's agency: the address book belongs to the agency, not the
office. A team outside the API key's scope answers 403.

date-time

Only entries changed on or after this time.

string

Order by field and direction. Format: field:direction (e.g., "dateUpdated:desc").
Allowed fields: companyName (the default), contactName, dateUpdated.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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