Document Participants

Inspect document participants and their linked Metorial resources.

Document Participants object

Attributes

object

String

String representing the object's type

id

String

role

Enum

edit_count

Number

last_edited_at

DateNullable

last_viewed_at

DateNullable

actor

Object

created_at

Date
{
  "object": "document.participant",
  "role": "editor",
  "actor": {
    "type": "organization_actor",
    "organization_actor": {
      "object": "organization.actor",
      "id": "omem_5fGhJkLmNpQrStUv",
      "type": "member",
      "organization_id": "org_7hNkPqRsTuVwXyZa",
      "name": "Alex Chen",
      "email": "[email protected]",
      "image_url": "https://avatar-cdn.metorial.com/aimg_1234567890",
      "teams": [
        {
          "id": "tm_3eFgHjKlMnPqRsTu",
          "name": "Engineering",
          "slug": "engineering",
          "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
        },
        {
          "id": "tm_3eFgHjKlMnPqRsTu",
          "name": "Engineering",
          "slug": "engineering",
          "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
        }
      ]
    },
    "consumer": {
      "object": "consumer"
    }
  }
}

List document participants

Returns a paginated list of participants for a specific document.

URL Parameters

document_id

String

The unique identifier for the document

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

id

UnionOptional

Filter by document participant ID

created_at

ObjectOptional

Filter Filter by creation time by date range

updated_at

ObjectOptional

Filter Filter by update time by date range

GEThttp://api.metorial.com/documents/:document_id/participants
curl -X GET "https://api.metorial.com/documents/doc_Rm4Mnheq2bfEPhBhP7SY/participants" \
  -H "Authorization: Bearer metorial_sk_..."

Get document participant by ID

Retrieves a specific document participant by its ID.

URL Parameters

document_id

String

The unique identifier for the document

document_participant_id

String

The unique identifier for the document_participant

GEThttp://api.metorial.com/documents/:document_id/participants/:document_participant_id
curl -X GET "https://api.metorial.com/documents/doc_Rm4Mnheq2bfEPhBhP7SY/participants/doc_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."