Skip to main content
GET
List a workspace's campaigns

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string<uuid>
required

Deprecated container id: a legacy workspace id OR a chat-session id (the session-container form is what v2 returns for new agents). Both resolve everywhere this parameter appears.

Response

The workspace's campaigns as summaries in the list envelope.

The canonical v2 list envelope. Every list endpoint returns this shape; per-endpoint items element types (and documented extras like total) are declared on each operation.

object
string
required
Allowed value: "list"
items
object[]
required

The page of objects. Element type is per-endpoint.

nextCursor
string | null
required

Cursor for the next page; null means this is the last page.

url
string
required

The path this list was fetched from (query string excluded).