Skip to main content
GET
Retirement

Authorizations

Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

id
string
required
Required string length: 20 - 37
Examples:

"ret_1FYBH4QDT1S0SVKF"

"ret_1CGV2XADRSBX1CHB"

Response

Successful Response

beneficiary
Organisation · object
required
credit_batch_size_total
CreditQuantity · object
required
id
string
required
Required string length: 20 - 37
Examples:

"ret_1FYBH4QDT1S0SVKF"

"ret_1CGV2XADRSBX1CHB"

notes
string | null
required
owner
Organisation · object
required
purposes
enum<string>[]
required
Available options:
corporate_targets,
public_environmental_claims,
insetting,
regulatory_requirement,
other
retired_at
string<date-time>
required
url
string
required