Skip to main content
GET
/
workspaces
/
{workspaceId}
/
campaigns
List a workspace's campaigns
curl --request GET \
  --url https://origami.chat/api/v2/workspaces/{workspaceId}/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "items": [
    {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "peopleCount": 123
    }
  ],
  "nextCursor": "<string>",
  "url": "<string>"
}

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

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