# List signing events

Read the event history of a signing request, oldest first. Use stable event IDs to avoid processing the same event twice. Read GetSigningRequest for current recipient status; events contain no document content or private audit details.

POST https://api.brigg.app/v1/operations/signing.ListSigningEvents

## Access & visibility

Allow `signing.ListSigningEvents` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `signing_request_id` | string | Yes | Keep the signing_request_id returned when invitations were requested. A file_id or signer_id identifies something else. [signing.RequestFileSignatures](https://developer.brigg.app/reference/signing/RequestFileSignatures). At least 1 character. |
| `cursor` | string | No | Copy next_cursor from the preceding response. Keep the same filters, sort and credential. |
| `limit` | integer | No | Maximum number of results to return in this page. Continue with next_cursor when returned. Default: `50`. Range: 1 to 200. |

## Follow one signing request through completion

[Upload a readable PDF](https://developer.brigg.app/files), then [request signatures](https://developer.brigg.app/reference/signing/RequestFileSignatures) and keep `signing_request_id`. The request keeps a fixed source; replacing the original file later does not change what recipients sign.

Read [Get signing request](https://developer.brigg.app/reference/signing/GetSigningRequest) for per-recipient progress. `completed` means everyone signed, but the archive can still be preparing: wait for non-null `file_id` before requesting the signed PDF. [Get signing document](https://developer.brigg.app/reference/signing/GetSigningDocument) returns a short-lived URL for either the fixed original or the signed archive.

Notification failures do not undo the signing request. Remind the affected pending recipients instead of creating a duplicate request. Recipients sign themselves; a delegated API call cannot supply a recipient's signature. See the [complete signing workflow](https://developer.brigg.app/signing).

## Response

Returns **200 OK** with a JSON body.

An empty `items` array means this page contains no matching visible results. Follow `next_cursor` when present.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Signing event](#signing-event-response-items) | Yes | Recorded events for the selected signing request. Pass next_cursor as cursor to continue when a next cursor is returned. |
| `next_cursor` | string or null | Yes | Pass this value as cursor to continue with the same filters, sort and credential. Null when there are no more results. |
| `has_more` | boolean | Yes | Whether more event history is available after this page. |

### Signing event · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `event_id` | string | Yes | Unique audit-event ID for deduplication when reading overlapping pages. |
| `type` | string | Yes | Recorded signing lifecycle event, such as signing.requested. Allowed: `"signing.requested"`, `"signing.opened"`, `"signing.signed"`, `"signing.cancelled"`, `"signing.deadline_changed"`, `"signing.reminded"`, `"signing.finalized"`. |
| `occurred_at` | integer | Yes | Event time in Unix milliseconds. |

## Pagination

Pass `next_cursor` as `cursor` on the next request, keeping the same query and acting identity. Stop when `next_cursor` is null. Treat the cursor as opaque; never construct or edit it.

```typescript
const query = {
  "signing_request_id": "sig_example",
  "limit": 50
};
let cursor;
do {
  const response = await fetch("https://api.brigg.app/v1/operations/signing.ListSigningEvents", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ ...query, ...(cursor ? { cursor } : {}) }),
  });
  const page = await response.json();
  if (!response.ok) throw new Error(`${response.status}: ${page.message}`);
  for (const item of page.items) {
    console.log(item); // Process or upsert each result.
  }
  cursor = page.next_cursor;
} while (cursor);
```


## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [Get signing request](https://developer.brigg.app/reference/signing/GetSigningRequest)
- [Get signing document](https://developer.brigg.app/reference/signing/GetSigningDocument)
- [Remind signers](https://developer.brigg.app/reference/signing/RemindSigners)
- [Send a document for signing](https://developer.brigg.app/signing)
- [Request file signatures](https://developer.brigg.app/reference/signing/RequestFileSignatures)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/signing.ListSigningEvents' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "signing_request_id": "sig_example",
  "limit": 50
}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/signing.ListSigningEvents", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "signing_request_id": "sig_example",
    "limit": 50
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "signing_request_id": "sig_example",
  "limit": 50
}
request = Request(
    "https://api.brigg.app/v1/operations/signing.ListSigningEvents",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "event_id": "audit_example",
      "type": "signing.requested",
      "occurred_at": 1794301200000
    }
  ],
  "next_cursor": null,
  "has_more": false
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "signing_request_id": {
      "type": "string",
      "minLength": 1,
      "description": "Keep the signing_request_id returned when invitations were requested. A file_id or signer_id identifies something else. [signing.RequestFileSignatures](https://developer.brigg.app/reference/signing/RequestFileSignatures)."
    },
    "cursor": {
      "type": "string",
      "description": "Copy next_cursor from the preceding response. Keep the same filters, sort and credential."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "default": 50,
      "description": "Maximum number of results to return in this page. Continue with next_cursor when returned."
    }
  },
  "required": [
    "signing_request_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "signing_request_id": "sig_example",
      "limit": 50
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "event_id": {
            "type": "string",
            "description": "Unique audit-event ID for deduplication when reading overlapping pages."
          },
          "type": {
            "type": "string",
            "enum": [
              "signing.requested",
              "signing.opened",
              "signing.signed",
              "signing.cancelled",
              "signing.deadline_changed",
              "signing.reminded",
              "signing.finalized"
            ],
            "description": "Recorded signing lifecycle event, such as signing.requested."
          },
          "occurred_at": {
            "type": "integer",
            "description": "Event time in Unix milliseconds."
          }
        },
        "required": [
          "event_id",
          "type",
          "occurred_at"
        ],
        "additionalProperties": false,
        "title": "Signing event"
      },
      "description": "Recorded events for the selected signing request. Pass next_cursor as cursor to continue when a next cursor is returned."
    },
    "next_cursor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass this value as cursor to continue with the same filters, sort and credential. Null when there are no more results."
    },
    "has_more": {
      "type": "boolean",
      "description": "Whether more event history is available after this page."
    }
  },
  "required": [
    "items",
    "next_cursor",
    "has_more"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "event_id": "audit_example",
          "type": "signing.requested",
          "occurred_at": 1794301200000
        }
      ],
      "next_cursor": null,
      "has_more": false
    }
  ]
}
```