KAkaleyra
Envelope

Get all envelopes

Get a list of sign envelopes.

get/v2/envelopes

Request

  • Base URL
    https://api.sandbox.eu.bandyer.com
  • URL
    https://api.sandbox.eu.bandyer.com/v2/envelopes
  • Auth
    API key in header apikey

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

fromstring date-time

Date value only days in YYYY-MM-DD

tostring date-time

Date value only days in YYYY-MM-DD

room_idstring

Id of the room.

session_idstring

Session id.

signerstring

User id of signer.

senderstring

User id of sender.

Response

offsetinteger

The number of items to skiped before starting to collect the result set.

limitinteger

The numbers of items to returned.

has_moreboolean

Indicates is there more values.

countinteger

Total number of values returned.

Example response

{
  "envelopes": [
    {
      "creation_date": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ]
}

Changes

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