outline icon

outline

Interact with outline API

Actions107

Collections → Collections Memberships

AI-generated

Summary

Retrieve user memberships for a specified Outline collection, with optional filtering by user query or permission level.

Inputs

  • id (required) — Identifier for the collection.
  • query — Filter memberships by user names.
  • permission — Filter memberships by permission level ('read' or 'read_write').
  • requestOptions — Additional request options such as proxy settings, request timeout, SSL cert validation, and request batching.

Output shape

a list of items

Returns the Outline API response containing user membership details for the collection.

Examples

Example 1: Get all members of a collection

Set Collection ID (id) to the target collection ID.

Example 2: Find members with read/write access

Set Collection ID (id) and set Permission (permission) to 'Read Write'.

Links

Discussion