REST API

Pagination

Three lists page: GET /v1/signing-requests, GET /v1/signing-requests/{id}/events and GET /v1/webhook-endpoints/{id}/deliveries. Each answers one page, newest first, and a next_cursor:

{"data": [ ... ], "next_cursor": "eyJ0IjoxOD..."}

Send next_cursor as cursor to get the next page. next_cursor is null on the last page.

curl -s "https://api.esoppari.fi/v1/signing-requests?status=completed&limit=50&cursor=eyJ0IjoxOD..." \
  -H "Authorization: Bearer $ESOPPARI_KEY"
  • limit is 1 to 100; the default is 25.
  • A cursor works only with the call that made it: the same filters, the same request or the same endpoint. Change one, and start again without a cursor.
  • A row added while you page does not move the pages: no row is skipped or shown twice.
  • A list leaves out the signers. Get one request for its signers.
  • A cursor is opaque. Do not parse it or build one.