DEdefaulr
Groups

List all group members

Changed on

List and filter all the members in a group.

post/groups.memberships

Request

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

Group id

querystring

Filter memberships by user names

Example request

{
  "limit": 25,
  "id": "a32c2ee6-fbde-4654-841b-0eabdc71b812",
  "query": "jenny"
}

Response

OK

Example response

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

Changes

  • c09b7940e788Revision changes
    • info

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

  • f1f0340cb0d7Revision changes
    • info

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

    • info

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