List Agreement Participants

GET /agreements/{agreement_ref}/participants

Returns a paginated canonical participant collection for an agreement visible to the authenticated actor.

Conventions

Authentication

All endpoints require a Bearer token. Pass it in the Authorization header as Bearer <token>. Tokens are issued from the API settings page in your workspace.

Base URL

All paths are relative to https://api.allsign.app. The spec includes full paths; strip the base when constructing requests.

Versioning

The current version is 0.1.0. Breaking changes are documented in the Changelog and announced before taking effect.

Specification

The API follows OpenAPI Specification 3.x. All documentation on this page is generated directly from the spec.

Example

Bash

curl "https://api.allsign.app/agreements/{agreement_ref}/participants" \
  -H "Authorization: Bearer {token}"

Request

Request Path

agreement_ref

Public agreement reference.

stringrequired

Parameters

Query

page

One-based page number.

integer = 1optional

page_size

Maximum number of records returned per page.

integer = 20optional

Responses

200 OK

Paginated participant list.

{
  "data": {
    "participants": [
      {
        "active": true,
        "actor": {},
        "avatar_url": "",
        "email": "",
        "name": "",
        "ref": "00000000-0000-4000-8000-000000000000",
        "type": "commentor"
      }
    ]
  }
}

data

Standard paginated collection metadata.

objectrequired

data.participants

object[]required

data.participants[].active

booleanrequired

data.participants[].actor

objectrequired

data.participants[].avatar_url

stringnullrequired

data.participants[].email

string (email)required

data.participants[].name

stringrequired

data.participants[].ref

Public stable resource reference.

string (uuid)required

data.participants[].type

commentor | editor | signer | viewerrequired

401 Unauthorized

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

404 Not Found

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional