Connections

Download Spec

get/tfapi/data/connection/{connection_id}

A single connection by connection id

connection_idint

required

Example: "1234"

Responses

Response examples

{
  "connection_id": "1234",
  "customer_id": 4321,
  "customer_name": "John Doe",
  "line_id": 123456789,
  "orderid": 123456,
  "ready_for_service_date": "2024-01-01T00:00:00Z",
  "closed_for_service_date": null,
  "active": 1,
  "external_connection_id": "external-id-1234",
  "gc_id": "gc-id-1234"
}

get/tfapi/data/connection

All available connections

x-request-idstring

Example: "<calculated when request is sent>"

REDACTEDstring

Example: "AAPIKEY"

Authorizationstring

Example: "AJWT"

Responses

Response examples

Succesful response

{
  "items": [
    {
      "connection_id": "1234",
      "customer_id": 4321,
      "customer_name": "John Doe",
      "line_id": 123456789,
      "orderid": 123456,
      "ready_for_service_date": "2024-01-01T00:00:00Z",
      "closed_for_service_date": null,
      "active": 1,
      "external_connection_id": "external-id-1234",
      "gc_id": "gc-id-1234"
    },
    {
      "connection_id": "ec-1234",
      "customer_id": 4321,
      "customer_name": "John Doe",
      "line_id": 45678123,
      "orderid": 223344,
      "ready_for_service_date": "2024-01-24T00:00:00Z",
      "closed_for_service_date": null,
      "active": 1,
      "external_connection_id": null,
      "gc_id": "gc-5522"
    }
  ],
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "count": 2
}

Was this page helpful?