Get all responses

GET

/v2/tenant/{tenantKey}/registered

const url = 'https://sender.api.kivra.com/v2/tenant/example/registered';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://sender.api.kivra.com/v2/tenant/example/registered \
  --header 'Authorization: Bearer <token>'

Get the responses of all registered letters that have been signed or expired. The response key can then be used to fetch the response details of each registered letter and also to delete the response.

Authorizations

oAuth2Client
get:kivra.v2.tenant.{tenantKey}

Parameters

Path Parameters

tenantKey

required

string format: hexadecimal

The unique key for a tenant for whom the registered letters belong to.

Responses

200

List of response statuses associated with registered letters that have been either signed or expired.

application/json

Array<object>

RegisteredLetterResponseStatusDetail

object

key

Response key

string

status

RegisteredLetterResponseStatus

Status of the registered letter response.

string

Allowed values: signed expired

Example

[
  {
    "status": "signed"
  }
]

401

Not authorized to make the request

404

No registered letter responses