Skip to content

tracking_profiles_list

List/search people (profiles) for the product; filter by email and status, cursor-paged.

Tool

tracking_profiles_list

List/search people (profiles) for the product; filter by email and status, cursor-paged.

List/search people (profiles) for the product; filter by email and status, cursor-paged.

Behavior

HTTP
GET /tracking/profiles

Arguments

Name
Type
Required
Description
email
string
—
Email to search people by — the whole address by default, or its beginning when emailMatch is prefix. Omit to search across everyone.
limit
integer
—
Max profiles per page (default 25, max 100)
cursor
string
—
Continue a previous page: pass the cursor that page returned. Omit to start from the most recently seen person.
status
string
—
Keep only people at this stage — anonymous, identified or customer. Omit to get all three.
emailMatch
string
—
How the email filter is matched: exact (default) compares the whole address case-insensitively, prefix matches everyone whose address starts with what you typed.

Response

Field
Type
Always
Description
cursor
string
•
Pass this back as `cursor` to fetch the next page. Null on the last page — that null is how a loop knows to stop.
profiles
array
•
The page of people, most recently seen first. Shorter than the requested limit on the last page.

Try it

List/search people (profiles) for the product; filter by email and status, cursor-paged.

When to use

List/search people (profiles) for the product; filter by email and status, cursor-paged.

Example

Ask your agent something like this:

List/search people (profiles) for the product; filter by email and status, cursor-paged.

The agent will invoke tracking_profiles_list with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select