MetorialDocs

Store Participants

Inspect participants assigned to an instance store.

The Store Participant object

store_participant.json
{
  "object": "store.participant",
  "id": "example_id",
  "store_id": "example_store_id",
  "permissions": [
    "content_read",
    "content_read"
  ],
  "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.660Z",
      "updated_at": "2026-10-17T09:50:02.660Z"
    },
    "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.660Z",
      "updated_at": "2026-10-17T09:50:02.660Z"
    },
    "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.660Z",
      "updated_at": "2026-10-17T09:50:02.660Z",
      "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.660Z",
            "updated_at": "2026-10-17T09:50:02.660Z"
          },
          "assigned_via": "default"
        }
      ]
    }
  },
  "created_at": "2026-10-17T09:50:02.660Z"
}
object"store.participant"required
idstringrequired
store_idstringrequired
permissions"content_read" | "content_write"[]required
created_atdaterequired

Endpoints

List store participants

GET/stores/:store_id/participants

Returns a paginated list of participants for a specific store.

Path parameters

store_idstringrequired

The unique identifier for the store

Query parameters

Example request

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

Get store participant by ID

GET/stores/:store_id/participants/:store_participant_id

Retrieves a specific participant within a store.

Path parameters

store_idstringrequired

The unique identifier for the store

store_participant_idstringrequired

The unique identifier for the store_participant

Example request

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