MetorialDocs

Document Participants

Inspect document participants and their linked Metorial resources.

The Document Participant object

document_participant.json
{
  "object": "document.participant",
  "id": "example_id",
  "role": "editor",
  "edit_count": 0,
  "last_edited_at": "2026-10-17T09:50:02.658Z",
  "last_viewed_at": "2026-10-17T09:50:02.658Z",
  "actor": {
    "type": "organization_actor",
    "name": "example_name",
    "image_url": "example_image_url",
    "email": "example_email",
    "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",
      "member": {
        "object": "organization.member#preview",
        "id": "ome_7hNkPqRsTuVwXyZa",
        "status": "active",
        "role": "member"
      },
      "teams": [
        {
          "id": "tm_3eFgHjKlMnPqRsTu",
          "name": "Engineering",
          "slug": "engineering",
          "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
        },
        {
          "id": "tm_3eFgHjKlMnPqRsTu",
          "name": "Engineering",
          "slug": "engineering",
          "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
        }
      ],
      "created_at": "2026-10-17T09:50:02.658Z",
      "updated_at": "2026-10-17T09:50:02.658Z"
    },
    "consumer": {
      "object": "consumer",
      "id": "example_id",
      "name": "example_name",
      "email": "example_email",
      "image_url": "example_image_url",
      "user_id": "example_user_id",
      "created_at": "2026-10-17T09:50:02.658Z",
      "updated_at": "2026-10-17T09:50:02.658Z"
    },
    "consumer_profile": {
      "object": "consumer.profile",
      "id": "example_id",
      "name": "example_name",
      "email": "example_email",
      "image_url": "example_image_url",
      "consumer_id": "example_consumer_id",
      "user_id": "example_user_id",
      "status": "active",
      "created_at": "2026-10-17T09:50:02.658Z",
      "updated_at": "2026-10-17T09:50:02.658Z",
      "groups": [
        {
          "object": "consumer.profile.group_assignment",
          "group": {
            "object": "consumer.group",
            "id": "example_id",
            "status": "active",
            "name": "example_name",
            "description": "example_description",
            "is_default": false,
            "created_at": "2026-10-17T09:50:02.658Z",
            "updated_at": "2026-10-17T09:50:02.658Z"
          },
          "assigned_via": "default"
        }
      ]
    }
  },
  "created_at": "2026-10-17T09:50:02.658Z"
}
object"document.participant"required
idstringrequired
role"editor" | "viewer"required
edit_countnumberrequired
last_edited_atdaterequirednullable
last_viewed_atdaterequirednullable
created_atdaterequired

Endpoints

List document participants

GET/documents/:document_id/participants

Returns a paginated list of participants for a specific document.

Path parameters

document_idstringrequired

The unique identifier for the document

Query parameters

idstring or string[]optional

Filter by document participant ID

Example request

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

Get document participant by ID

GET/documents/:document_id/participants/:document_participant_id

Retrieves a specific document participant by its ID.

Path parameters

document_idstringrequired

The unique identifier for the document

document_participant_idstringrequired

The unique identifier for the document_participant

Example request

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