DEdefaulr
Documents

List document memberships

Changed on

Users with direct membership to a document. To list all users with access to a document use documents.users.

post/documents.memberships

Request

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

permission'read' | 'read_write'

Example request

{
  "id": "hDYep1TPAM"
}

Response

OK

Example response

{
  "data": {
    "users": [
      {
        "name": "Jane Doe"
      }
    ]
  },
  "pagination": {
    "limit": 25
  }
}

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

    • 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

    • 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