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

Company ID that owns the list. Required when authenticating with a personal access key (pak_…) — the key is not tied to a specific company so the server cannot infer it. Required when authenticating with a company API key only if the key belongs to a user who has access to multiple companies; otherwise it defaults to the key's company. Optional for JWT (dashboard) auth — defaults to the user's active company.

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

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).

has_next
boolean

Whether another page is available

items
object[]

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

page
integer

Current page number (1-indexed)

pages
integer

Total number of pages

total
integer

Total number of lists matching the query