Sign in

v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Organisation Orders

A paginated list of all orders placed by the organisation, sorted by descending placement date.

get/organisations/{id}/orders

Path parameters

idstring required
Example:org_1GB56M1ST1S0GVNA

The ID of the organisation

Query parameters

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

A secret token identifying the client connecting to the API

Response

Successful Response

total_countinteger required

Example response

{
  "nodes": [
    {
      "id": "ord_1FAN3S3WV1S0B842",
      "buyer_organisation": {
        "id": "org_1GB56M1ST1S0GVNA",
        "name": "Isometric",
        "domain": "isometric.com"
      },
      "supplier": {
        "id": "spl_1CC712KFS1S0YKPS",
        "organisation": {
          "id": "org_1GB56M1ST1S0GVNA",
          "name": "Isometric",
          "domain": "isometric.com"
        },
        "location": {
          "country_code": "GBR",
          "latitude": 51.5072,
          "longitude": -0.1276
        }
      },
      "credits_ordered": {
        "credits": 125.632,
        "credit_kgs": 125632
      },
      "credits_delivered": {
        "credits": 125.632,
        "credit_kgs": 125632
      }
    }
  ]
}