DEdefaulr
Documents

List document users

Changed on

All users with access to a document. To list only users with direct membership to the document use documents.memberships

post/documents.users

Request

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

idstring required

Unique identifier for the document. Either the UUID or the urlId is acceptable.

querystring

If set, will filter the results by user name.

userIdstring uuid

If set, will filter the results to a specific user.

Example request

{
  "id": "hDYep1TPAM"
}

Response

OK

Example response

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

Changes

  • 9a99ee93e11dRevision changes
    • info

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

  • 304cd065561bRevision changes
    • breaking

      the response property // became nullable for the status

    • info

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

    • info

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

    • info

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

    • info

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