Signings

List signings

get/v1/signings

Request

  • Base URL: https://sign-api.tvarka.pro
  • URL: https://sign-api.tvarka.pro/v1/signings
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://sign-api.tvarka.pro/oauth/authorize, token URL https://sign-api.tvarka.pro/oauth/token, scopes: sign.read, sign.signings)

Query parameters

status'pending' | 'completed' | 'declined' | 'cancelled' | 'expired' | 'failed'

pending - at least one signer can still sign. completed - every signer signed. declined - somebody declined and nobody else can still sign. expired - the window closed first. cancelled - you retracted it. failed - the signing could not be prepared.

limitinteger
startingAfterstring uuid
externalIdstring

Only signings created with this externalId (v1.12.0).

Response

A newest-first page ordered by creation time then UUID, both descending.

hasMoreboolean required
nextCursorstring uuid nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.