Skip to main content
GET
Retrieve a list and its members

Authorizations

Authorization
string
header
required

A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.

Path Parameters

id
string
required

The list's id.

Query Parameters

limit
integer
default:50

Members per page (1–200).

Required range: 1 <= x <= 200
offset
integer
default:0

Members to skip.

Required range: x >= 0

Response

200 - application/json

The list and a page of members.

data
object
reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"