---
title: "List document group memberships"
method: POST
path: "/documents.group_memberships"
tags: ["Documents"]
---

# List document group memberships

`POST /documents.group_memberships`

## Request

- Base URL: `https://app.getoutline.com/api`
- URL: `https://app.getoutline.com/api/documents.group_memberships`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://app.getoutline.com/oauth/authorize`
    - Token URL: `https://app.getoutline.com/oauth/token` scopes: `read`, `write`

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

## Request body

- object
  - `offset` number
  - `limit` number
  - `id` string, required: Unique identifier for the document. Either the UUID or the urlId is acceptable.
  - `query` string: Filter memberships by group names
  - `permission` 'read' | 'read_write'

## Response `200`

OK

- object
  - `data` object
    - `groups` Group[]
      - `id` string, uuid: Unique identifier for the object.
      - `name` string: The name of this group.
      - `description` string, nullable: A short description of this group.
      - `icon` string, nullable: An icon or emoji to use as the group icon.
      - `color` string, nullable: The color of the group icon in hex format.
      - `externalId` string, nullable: An identifier for this group in an external system, if linked.
      - `disableMentions` boolean: Whether mentioning this group is disabled.
      - `externalGroup` object, nullable: Details of the linked external group, if any.
      - `memberCount` number: The number of users that are members of the group
      - `createdAt` string, date-time: The date and time that this object was created
      - `updatedAt` string, date-time: The date and time that this object was last changed
    - `groupMemberships` CollectionGroupMembership[]
      - `id` string: Unique identifier for the object.
      - `groupId` string, uuid: Identifier for the associated group.
      - `documentId` string, uuid, nullable: Identifier for the associated document, if any.
      - `collectionId` string, uuid, nullable: Identifier for the associated collection, if any.
      - `permission` 'read' | 'read_write'
      - `sourceId` string, uuid, nullable: Identifier for the membership this one was inherited from, if any.
  - `pagination` Pagination
    - `offset` number
    - `limit` number

## Other responses

- `400`: The request failed one or more validations.
- `401`: The API key is missing or otherwise invalid.
- `403`: The current API key is not authorized to perform this action.
- `404`: The specified resource was not found.
- `429`: The request was rate limited.

## Changes

- **2026-10-13** `527f5b8079a2`: 2 info
  - added the optional property `data/groups/items/color` to the response with the `200` status
  - added the optional property `data/groups/items/icon` to the response with the `200` status
- **2026-05-30** `304cd065561b`: 1 breaking, 6 info
  - the response property `data/groupMemberships/items/collectionId` became nullable for the status `200`
  - added the optional property `data/groupMemberships/items/documentId` to the response with the `200` status
  - added the optional property `data/groupMemberships/items/sourceId` to the response with the `200` status
  - added the optional property `data/groups/items/description` to the response with the `200` status
  - …3 more
- **2026-02-01** `2b998aa571f9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/defaulr/apis/outline-api/changes/documents.group_memberships/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) - [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/defaulr/apis/outline-api/revisions/5ddf01ffba84?raw)