Tenant API - Agreements

List all agreements for a tenant, with their current status

List all agreements created by a tenant, with their current status.

get/v1/tenant/{tenantKey}/agreement

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v1/tenant/{tenantKey}/agreement
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The unique Key for a Tenant

Response

List of agreements and their status

keystring

unique agreement id

state'active' | 'generating' | 'completed' | 'revoked'

current state for the agreement

Example response

[
  {
    "key": "1527232009ba54f8186d8c43e2a3c8092b57ca2739",
    "state": "active"
  },
  {
    "key": "155265136911763308f2514ff3aa6dacc8211a2107",
    "state": "revoked"
  },
  {
    "key": "15100645203cff9f19d92443848c8a2f1cbf257510",
    "state": "completed"
  }
]

Changes

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