DEdefaulr
Collections

List all collections

Changed on

List all collections that the authenticated user has access to.

post/collections.list

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/collections.list
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

offsetnumber
limitnumber
sortstring
direction'ASC' | 'DESC'
querystring

If set, will filter the results by collection name. Deprecated – prefer the filters parameter.

statusFilterCollectionStatus[]

An optional array of statuses to filter by. Deprecated – prefer the filters parameter.

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

OK

Example response

{
  "data": [
    {
      "urlId": "hDYep1TPAM",
      "name": "Human Resources",
      "index": "P",
      "color": "#123123",
      "archivedBy": {
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "limit": 25
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes