Sign in
Outline collections

List the Outline collections available to mirror (live proxy; doubles as connectivity probe)

Proxies Outline's collections.list with the stored token under a bounded interactive page budget. Served with Cache-Control: no-store — the live upstream view must not be cached.

get/workspaces/{workspaceSlug}/outline/collections/candidates

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/outline/collections/candidates
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Response

Candidate collections returned (Cache-Control: no-store)

alreadyMirroredboolean required

Whether this collection is already registered for mirroring

collectionIdstring required

Outline collection id (UUID)

colorstring

Collection color as configured in Outline

descriptionstring

Collection description as shown in Outline

iconstring

Collection icon as configured in Outline

namestring

Collection name as shown in Outline

urlIdstring

Outline url id (the short slug in collection URLs)

Changes

No recorded changes to this operation across all 1 revision of this API.