Skip to main content
GET
List segments

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Query Parameters

workspaceId
string<cuid2>
required

Workspace identifier.

limit
integer
default:50

Page size (max 250).

Required range: 1 <= x <= 250
cursor
string

Opaque cursor returned as meta.nextCursor from the previous page.

includeTotalCount
boolean
default:false

Whether to calculate meta.totalCount. Send true on the first page to get the count; when omitted or false the count query is skipped and meta.totalCount is null.

filter[title][contains]
string

Case-insensitive substring match on the segment title.

Maximum string length: 512
sortBy
enum<string>
default:-updatedAt

-updatedAt (default), -createdAt (both newest first) or title (A–Z).

Available options:
-updatedAt,
-createdAt,
title

Response

Segments retrieved successfully

data
object[]
required
meta
object
required

A list meta carrying pagination and the filtered total. totalCount is required but nullable, gated on the operation's includeTotalCount parameter.