Collections overview

Collections group wiki pages in a workspace.

The collection object

Attributes

• access integer

  Who can see this.

• created_at string (date-time)

  When the record was created.

• created_by_id string (uuid)

  The user who created the record.

• id string (uuid)

  Unique identifier.

• is_default boolean

  Make this the default for its parent. Setting it clears the flag on the previous default.

• is_global boolean

  Whether this lives at the workspace level rather than inside a project.

• logo_props string

  Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

• name string

  Display name.

• owned_by_id string (uuid)

  The related owned by.

• page_ids array of string

  Ids of the associated pages.

• sort_order number

  Manual ordering weight. Lower sorts first.

Response200

{
  "access": 0,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_default": false,
  "is_global": false,
  "logo_props": null,
  "name": "Example name",
  "owned_by_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "page_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  "sort_order": 65535
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/collections/{pk}/members/	List collection members
GET	/api/v2/workspaces/{slug}/collections/	List collections
GET	/api/v2/workspaces/{slug}/collections/{pk}/	Get a collection
POST	/api/v2/workspaces/{slug}/collections/	Create a collection
PATCH	/api/v2/workspaces/{slug}/collections/{pk}/	Update a collection
DELETE	/api/v2/workspaces/{slug}/collections/{pk}/	Delete a collection
POST	/api/v2/workspaces/{slug}/collections/{pk}/members/	Add or remove collection members
POST	/api/v2/workspaces/{slug}/collections/{pk}/pages/	Add or remove pages in a collection
GET	/api/v2/workspaces/{slug}/collections/{pk}/pages-search/	Search pages for a collection

Response shaping

Every collection read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.