Skip to main content
GET
/
threads
/
{id}
Get Thread
curl --request GET \
  --url https://v1.api.flux-os.com/threads/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": {
    "id": "<string>",
    "type": {
      "name": "<string>",
      "short_code": "<string>",
      "id": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "organizations": [
      {
        "name": "<string>",
        "slug": "<string>",
        "id": "<string>",
        "url": null,
        "phone": null,
        "email": null,
        "image_url": null,
        "short_code": null
      }
    ],
    "participants": [
      {
        "stytch_id": "<string>",
        "organization": "<unknown>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "title": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "roles": "<unknown>",
        "permissions": "<unknown>"
      }
    ],
    "contracts": [
      {
        "external_id": "<string>",
        "organization": "<unknown>",
        "term": "<unknown>",
        "transaction_type": "<unknown>",
        "type": "<unknown>",
        "start_date": "2023-12-25",
        "volume": 123,
        "volume_measurement_unit": "<unknown>",
        "measurement_type": "<unknown>",
        "pricing_basis": "<unknown>",
        "settlement_currency": "<unknown>",
        "payment_term": "<unknown>",
        "id": "<string>",
        "status": "<unknown>",
        "end_date": null,
        "differential_unit_amount": null,
        "differential_currency": "<unknown>",
        "differential_measurement_unit": "<unknown>",
        "percentage_of_index": null,
        "percentage_of_index_measurement_unit": "<unknown>",
        "percentage_of_benchmark": null,
        "percentage_of_benchmark_measurement_unit": "<unknown>",
        "eq": "<unknown>",
        "index": "<unknown>",
        "product_category": "<unknown>",
        "stream": "<unknown>",
        "benchmark": "<unknown>",
        "stream_wadf": "<unknown>",
        "feeder_wadf": "<unknown>",
        "broker_transaction_id": null,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "schedules": [
      {
        "contract": "<unknown>",
        "production_month": "2023-12-25",
        "volume": 123,
        "volume_measurement_unit": "<unknown>",
        "id": "<string>",
        "status": "<unknown>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "users": [
      {
        "stytch_id": "<string>",
        "organization": "<unknown>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "title": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "roles": "<unknown>",
        "permissions": "<unknown>"
      }
    ],
    "entities": [
      {
        "legal_name": "<string>",
        "effective_date": "2023-12-25",
        "id": "<string>",
        "organization": "<unknown>",
        "url": null,
        "phone": null,
        "email": null,
        "unit": null,
        "street": null,
        "city": null,
        "zip_code": null,
        "province": null,
        "state": null,
        "postal_code": null,
        "country": null,
        "regulator_id": null,
        "regulator_system": "PETRINEX",
        "jurisdiction": "ALBERTA",
        "status": "START",
        "successor": "<unknown>",
        "business_lines": "<unknown>"
      }
    ],
    "messages": [
      {
        "thread": "<unknown>",
        "from_user": "<unknown>",
        "message": "<string>",
        "id": "<string>",
        "reply_to": "<unknown>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "facilities": [
      {
        "name": "<string>",
        "type": "<unknown>",
        "sub_type": "<unknown>",
        "start_date": "2023-12-25",
        "operator": "<unknown>",
        "operator_start_date": "2023-12-25",
        "id": "<string>",
        "latitude": null,
        "longitude": null,
        "lsd": null,
        "section": null,
        "township": null,
        "range": null,
        "meridian": null,
        "operational_status": "ABANDONED",
        "licensee": "<unknown>",
        "license_status": "ABANDONED",
        "license_type": "WELL",
        "license_number": null,
        "license_issued": null,
        "jurisdiction": "ALBERTA",
        "regulator_id": null,
        "regulator_system": "PETRINEX"
      }
    ],
    "commercial_facilities": [
      {
        "name": "<string>",
        "organization": "<unknown>",
        "id": "<string>",
        "latitude": null,
        "longitude": null,
        "lsd": null,
        "section": null,
        "township": null,
        "range": null,
        "meridian": null
      }
    ]
  }
}

Authorizations

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

Path Parameters

id
integer
required

The thread ID.

Response

A single thread object containing thread details.

data
object