ISisometric

Retirement

Changed on

Information about a specific retirement.

get/retirements/{id}

Request

  • Base URL
    https://api.isometric.com/registry/v0
  • URL
    https://api.isometric.com/registry/v0/retirements/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:ret_1FYBH4QDT1S0SVKF

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Response

Successful Response

idstring required
retired_atstring date-time required
purposesRetirementPurpose[] required
urlstring required
notesstring nullable required

Example response

{
  "id": "ret_1FYBH4QDT1S0SVKF",
  "beneficiary": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "owner": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "credit_batch_size_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  }
}

Changes

  • 385518aba17dRevision changes
    • breaking

      for the path request parameter id, the minLength was increased from 0 to 20

    • warning

      for the path request parameter id, the maxLength was set to 37

    • info

      for the path request parameter id, the type was generalized from no type to string

  • f1623e0dc2e1Revision changes
    • info

      for the path request parameter id, the type was generalized from string to no type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status