DEdefaulr
Users

List all users

Changed on

List and filter all the users in the workspace

post/users.list

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/users.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
emailsstring[]

Array of emails. Deprecated – prefer the filters parameter with an email field and the in operator.

filter'all' | 'invited' | 'active' | 'suspended'

The status to filter by. Deprecated – prefer the filters parameter (for example filter on suspendedAt or lastActiveAt).

role'admin' | 'member' | 'viewer' | 'guest'

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC",
  "query": "jane",
  "emails": [
    "jane.crandall@mail.com",
    "prudence.crandall@mail.com"
  ]
}

Response

OK

Example response

{
  "data": [
    {
      "name": "Jane Doe"
    }
  ],
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

  • dff00215628fRevision changes
    • breaking

      added to the / request property allOf list

    • breaking

      removed the enum value admin of the request property /

    • breaking

      removed the enum value guest of the request property /

    • breaking

      removed the enum value member of the request property /

    • breaking

      removed the enum value viewer of the request property /

    • breaking

      the / request property type changed from string to no type

    • info

      added the new optional request property /

    • info

      request property / deprecated

    • info

      request property / deprecated

    • info

      request property / deprecated

  • 9a99ee93e11dRevision changes
    • info

      added the optional property // to the response with the status