List lists

get

https://api.delivr.ai/api/v1/lists

Retrieve lists with optional filtering. The organization comes from the API key, so key callers do not need organization_id.

Response shape. Without limit or offset the response is a bare array of lists. Send either and it becomes {"data": [...], "total_count": N}.

Search, sort and comma-separated filters need a page. query, sort_by, sort_order and a comma-separated type or source work only with project_id and limit together. Any other request that names one is refused with 400, never silently ignored. A single type or source value also works with organization scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

organization_id

uuid

Optional for API key callers: the organization is taken from the key. If sent, it must be the key's own.

project_id

uuid

Filter by project ID (UUID).

integration_id

uuid

Filter by integration ID (UUID).

type

string

Filter by type (comma-separated): hem, email, contact, account, domain, zipcode, phone, address, uid2, eid, ip, maid.

Unlike the type field on a list, the filter is a closed set: a value outside this list is refused rather than matching nothing, so a typo is answered instead of returning an empty page.

source

string

Filter by source (comma-separated): upload, csv_upload, import, manual, export, salesforce, hubspot, delivrdsp, delivrdsp_events, delivrdsp_uid2.

Closed set, as with type. Filter on the same spelling the response gives you; the values above are exactly what a list can report.

query

string

Search by list name (case-insensitive partial match).

limit

integer

≤ 1000

Defaults to 25

Maximum number of results to return (default 25, max 1000). Sending it, or offset, switches the response to {data, total_count}.

offset

integer

Defaults to 0

Number of results to skip (default 0).

sort_by

string

enum

Sort by field.

Allowed:

sort_order

string

enum

Defaults to desc

Sort order: asc or desc. Defaults to desc, so an unsorted request returns the newest lists first. Accepted with or without sort_by.

Allowed:

Responses

401

Missing or invalid authentication.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of lists.

400Invalid UUID or filter value, or an argument the request cannot apply (for example query or sort_by without project_id and limit).