List signing events — Brigg developers

Access & visibility

Allow signing.ListSigningEvents on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

signing_request_idstringRequired

Keep the signing_request_id returned when invitations were requested. A file_id or signer_id identifies something else. signing.RequestFileSignatures.

At least 1 character.

cursorstringOptional

Copy next_cursor from the preceding response. Keep the same filters, sort and credential.

limitintegerOptional

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, then request signatures 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 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 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.

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.

itemsarray of Signing eventRequired

Recorded events for the selected signing request. Pass next_cursor as cursor to continue when a next cursor is returned.

Item fields

event_idstringRequired

Unique audit-event ID for deduplication when reading overlapping pages.

typestringRequired

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_atintegerRequired

Event time in Unix milliseconds.

next_cursorstring or nullRequired

Pass this value as cursor to continue with the same filters, sort and credential. Null when there are no more results.

has_morebooleanRequired

Whether more event history is available after this page.

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.

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 and safe retries and limits.

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

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "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](/developers/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
    }
  ]
}

Full response JSON schema

{
  "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
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

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

Request

cURL

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

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

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

cURL

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

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

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",
    "Brigg-Act-As": actAs,
  },
  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

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",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

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

Illustrative values, not a live response.