ISisometric

Retirements

Changed on

A paginated list of all retirements on Isometric's registry.

Returned list of retirements will be sorted by most recently delivered first.

get/retirements

Request

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

Query parameters

beneficiary_org_idstring
Example:org_1GB56M1ST1S0GVNA
owner_org_idstring
Example:org_1GB56M1ST1S0GVNA
lastinteger

An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.

beforestring nullable

An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page’s start_cursor here when paginated backwards.

firstinteger

An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.

afterstring nullable

An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page’s end_cursor here when paginated forwards.

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Response

Successful Response

total_countinteger required

Example response

{
  "nodes": [
    {
      "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
    • warning

      for the query request parameter beneficiary_org_id, the type of property anyOf[IsometricIDQueryParam_Organisation_]/ changed from no type to string

    • warning

      for the query request parameter owner_org_id, the type of property anyOf[IsometricIDQueryParam_Organisation_]/ changed from no type to string

  • f1623e0dc2e1Revision changes
    • info

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

    • info

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