List Rows

Retrieves rows from an audience with support for filtering, sorting, and pagination. Rows are individual contact or company records; each row contains cells keyed by columnId, where each cell reports its value and a CellStateRESULT (value present), BLANK (no value set), LOADING (enrichment in progress), ERROR (enrichment failed for this cell), or NO_RESULT (enrichment returned no match). Provide filter criteria in the request body to narrow results by column values and conditions using AND/OR logic. Use page[number] and page[size] (default 25, max 100) to paginate through results. Use the sort query parameter with a columnId value and a - prefix for descending order. Use the columns query parameter to limit which columns are returned per row. Returns 200 with a paginated array of rows and navigation links. Returns 400 if filter criteria are malformed or column references are invalid.

Path Params
uuid
required

The unique identifier for the audience

Query Params
int32
≥ 1
Defaults to 1

Page number for the results.

int32
1 to 500
Defaults to 25

Number of records to return per page. Default is 25.

string

ColumnId based on which to sort the results. Use '-' prefix for descending order.

columns
array of strings

List of column IDs to include in the response, If provided, only these columns will be returned for each row.

columns
Body Params

Request body containing the row search criteria

data
object
required

Row Get request resource.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json