Skip to main content
GET
Export a list to CSV.

Authorizations

X-API-Key
string
header
required

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

Path Parameters

listId
string
required

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 for rows (default: 1)

pageSize
integer
default:50

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

sortField
string

Column name to sort by. Use the reserved value "dateAdded" to sort by row creation time. Defaults to row creation time.

sortOrder
string
default:desc

Sort order: "asc" or "desc" (default: "desc")

searchQuery
string

Substring to match within row values

searchField
string

Column name to restrict the search to. Use "all" or omit to search across all columns.

filterModel
string

JSON-encoded MUI DataGrid filter model. Supported operators: contains, equals, startsWith, endsWith, notEquals, isEmpty, isNotEmpty.

Response

Invalid credentials

error
string

Error message