DEdefaulr
Groups

List all groups

Changed on

List all groups in the workspace. Groups are used to organize users and manage permissions for collections.

post/groups.list

Request

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

Filter to groups including a specific user

externalIdstring uuid

Filter to groups matching an external ID

querystring uuid

Filter to groups matching a search query

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

OK

Example response

{
  "data": {
    "groups": [
      {
        "name": "Engineering",
        "memberCount": 11
      }
    ],
    "groupMemberships": [
      {
        "createdBy": {
          "name": "Jane Doe"
        }
      }
    ]
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

  • c09b7940e788Revision changes
    • info

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

  • 527f5b8079a2Revision changes
    • info

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

    • info

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