Skip to main content
GET
/
contracts
/
schedules
List Contract Schedules
curl --request GET \
  --url https://v1.api.flux-os.com/contracts/schedules \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "production_month": "2023-12-25",
      "volume": 123,
      "id": "<string>",
      "contract": {
        "external_id": "<string>",
        "id": "<string>"
      },
      "status": {
        "name": "<string>",
        "short_code": "<string>",
        "id": "<string>"
      },
      "volume_measurement_unit": {
        "name": "<string>",
        "abbreviation": "<string>",
        "id": "<string>",
        "html_symbol": null
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "estimated_qualities": [
        {
          "value": 123,
          "id": "<string>",
          "measurement_property": {
            "name": "<string>",
            "short_code": "<string>",
            "id": "<string>"
          },
          "measurement_unit": {
            "name": "<string>",
            "abbreviation": "<string>",
            "id": "<string>",
            "html_symbol": null
          },
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "chains": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "legs": [
            {
              "position": 123,
              "chain": "<unknown>",
              "volume": 123,
              "id": "<string>",
              "mode": {
                "name": "<string>",
                "short_code": "<string>",
                "id": "<string>"
              },
              "source_well": {
                "id": "<string>",
                "name": null
              },
              "source_commercial_facility": {
                "name": "<string>",
                "id": "<string>",
                "lsd": null,
                "section": null,
                "township": null,
                "range": null,
                "meridian": null
              },
              "source_facility": {
                "name": "<string>",
                "id": "<string>"
              },
              "source_land_description": {
                "description": "<string>",
                "latitude": 123,
                "longitude": 123,
                "id": "<string>",
                "survey_system": {
                  "name": "<string>",
                  "short_code": "<string>",
                  "id": "<string>"
                },
                "unit": {
                  "name": "<string>",
                  "short_code": "<string>",
                  "id": "<string>"
                }
              },
              "destination_commercial_facility": {
                "name": "<string>",
                "id": "<string>",
                "lsd": null,
                "section": null,
                "township": null,
                "range": null,
                "meridian": null
              },
              "destination_facility": {
                "name": "<string>",
                "id": "<string>"
              },
              "volume_measurement_unit": {
                "name": "<string>",
                "abbreviation": "<string>",
                "id": "<string>",
                "html_symbol": null
              },
              "custodian_organization": {
                "name": "<string>",
                "id": "<string>",
                "image_url": null
              },
              "custodian_entity": {
                "legal_name": "<string>",
                "id": "<string>"
              },
              "is_custody_transfer": false,
              "is_chain_source": false,
              "is_chain_destination": false,
              "fob": false,
              "carrier_organization": {
                "name": "<string>",
                "id": "<string>",
                "image_url": null
              },
              "carrier_entity": {
                "legal_name": "<string>",
                "id": "<string>"
              },
              "carrier_user": {
                "first_name": "<string>",
                "last_name": "<string>",
                "id": "<string>"
              },
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "per_page": 123
  }
}

Authorizations

​
x-api-key
string
header
required
​
x-user-id
string
header
required

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
production_month
string<date>

Production month in format YYYY-MM-DD

​
status
integer

Schedule Status

​
party_user_id
integer

Party User ID

​
contract_external_id
string

Contract External ID

​
sort_by
enum<string>

Field to sort by

Available options:
id,
production_month,
status,
created_at,
updated_at
​
sort_order
enum<string>
default:asc

Sort direction (asc or desc)

Available options:
asc,
desc

Response

A paginated list of schedules.

​
data
object[]
​
meta
object