/api/collection

GET /api/collection

Changed on

Fetch a list of all Collections that the current user has read permissions for (:can_write is returned as an additional property of each Collection so you can tell which of these you have write permissions for.)

By default, this returns non-archived Collections, but instead you can show archived ones by passing ?archived=true.

By default, admin users will see all collections. To hide other user's collections pass in ?exclude-other-user-collections=true.

If personal-only is true, then return only personal collections where personal_owner_id is not nil.

get/api/collection

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Query parameters

archivedboolean nullable

value must be a valid boolean string ('true' or 'false').

exclude-other-user-collectionsboolean nullable

value must be a valid boolean string ('true' or 'false').

namespacestring nullable

value must be a non-blank string.

personal-onlyboolean nullable

value must be a valid boolean string ('true' or 'false').

Request body

object required

Response

Successful response

Changes

    • info

      added optional request body

    • info

      the query request parameter archived became optional

    • info

      the query request parameter exclude-other-user-collections became optional

    • info

      the query request parameter personal-only became optional

    • info

      added the media type application/json for the response with the status

    • breaking

      api path removed without deprecation

    • info

      endpoint added