DEdefaulr
Documents

List document group memberships

Changed on

This method allows you to list a document's group memberships.

post/documents.group_memberships

Request

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

offsetnumber
limitnumber
idstring required

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

querystring

Filter memberships by group names

permission'read' | 'read_write'

Example request

{
  "limit": 25
}

Response

OK

Example response

{
  "data": {
    "groups": [
      {
        "name": "Engineering",
        "memberCount": 11
      }
    ]
  },
  "pagination": {
    "limit": 25
  }
}

Changes

  • 527f5b8079a2Revision changes
    • info

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

    • 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

    • info

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

    • info

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