Skip to main content
GET
List all smart lists for the current company.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Query Parameters

companyId
string
required

Company ID.

page
integer
default:1

Page number (default: 1)

pageSize
integer
default:50

Items per page (default: 50, max: 100)

Search query to filter lists by name (case-insensitive substring match)

minimal
boolean
default:false

If true, each item in the response only includes id, name, and type — useful for populating dropdowns without N+1 queries. Default: false

sortBy
enum<string>

Field to sort by: 'createdDate' (default) or 'updatedDate'

Available options:
createdDate,
updatedDate
sortOrder
enum<string>

Sort direction: 'asc' (default) or 'desc'

Available options:
asc,
desc

Response

Paginated list of lists

Paginated lists response. The shape of items depends on the minimal query parameter: by default each item is a ListSummary (with row count, automations count, etc.); when minimal=true each item is a ListMinimal (id, name, type only).

items
object[]

Page of lists. See schema description for shape differences when minimal=true.

total
integer

Total number of lists matching the query

page
integer

Current page number (1-indexed)

pages
integer

Total number of pages

has_next
boolean

Whether another page is available