Skip to main content
POST
Search lists

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
offset
integer
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
limit
integer
default:100

Max records to return (1–100). Defaults to 100.

Required range: 1 <= x <= 100
sort_by
enum<string>
default:created_at

Column to sort by. Accepted values: name, created_at, updated_at, item_count. Defaults to created_at.

Available options:
name,
created_at,
updated_at,
item_count
sort_order
enum<string>
default:desc

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc
keywords
string

Search keyword to filter lists by name. Case-insensitive partial match.

list_type
enum<string>

Filter by list type: "persons" or "companies". Omit to return all types.

Available options:
persons,
companies
is_archived
boolean
default:false

When true, return archived lists only. When false (default), return non-archived lists.

owner_ids
string<uuid>[]

Filter to lists owned by these team member UUIDs.

is_public
boolean

Filter by public/private visibility. Omit to return both.

Response

Successful search response

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required