Document Participants

List document participants

Returns a paginated list of participants for a specific document.

get/documents/{document_id}/participants

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Path parameters

document_idstring required

Unique identifier of the document.

Query parameters

limitnumber
afterstring
beforestring
cursorstring
order'asc' | 'desc'
string
OR
string[]

Filter by document participant ID

gtstring date-time

Only include records after this timestamp for Filter by creation time

ltstring date-time

Only include records before this timestamp for Filter by creation time

Filter Filter by creation time by date range

gtstring date-time

Only include records after this timestamp for Filter by update time

ltstring date-time

Only include records before this timestamp for Filter by update time

Filter Filter by update time by date range

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Response

Successful response

Example response

{
  "items": [
    {
      "actor": {
        "organization_actor": {
          "id": "omem_5fGhJkLmNpQrStUv",
          "organization_id": "org_7hNkPqRsTuVwXyZa",
          "name": "Alex Chen",
          "email": "alex.chen@acme.com",
          "image_url": "https://avatar-cdn.metorial.com/aimg_1234567890",
          "member": {
            "id": "ome_7hNkPqRsTuVwXyZa"
          },
          "teams": [
            {
              "id": "tm_3eFgHjKlMnPqRsTu",
              "name": "Engineering",
              "slug": "engineering",
              "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
            }
          ]
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.