Skip to main content
GET
/
v1
/
sites
/
dispatch
Retrieve Sites based on the current Dispatch results
curl --request GET \
  --url https://api.tread-horizon.com/v1/sites/dispatch \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "name": "<string>",
      "lat": "<string>",
      "lon": "<string>",
      "notes": "<string>",
      "state": "active",
      "external_id": "<string>",
      "full_address": "<string>",
      "routable": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "discarded_at": "2023-11-07T05:31:56Z",
      "address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "thoroughfare": "<string>",
        "premise": "<string>",
        "locality": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>",
        "country": "US",
        "lat": "<string>",
        "lon": "<string>",
        "place_id": "<string>"
      },
      "site_type": "Plant",
      "next_billion_geofence": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "geofence": {
          "name": "<string>",
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "geojson": {
            "type": "<string>",
            "coordinates": [
              [
                [
                  "<unknown>"
                ]
              ]
            ]
          },
          "circle_center": {
            "lat": 123,
            "lon": 123
          },
          "circle_radius": 123,
          "tag": "pickup"
        },
        "moving_geofence": false,
        "tag": "scaling",
        "geofence_type": "moving"
      },
      "moving_site": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "equipment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "polling_interval_seconds": 123
      },
      "department": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "contacts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "<string>",
          "phone": "+18885551234"
        }
      ],
      "editable": true,
      "company_share": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "ticket_match_id": "<string>",
        "sender_company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "dispatchable": true,
        "schedule_on": true,
        "rate_override": true,
        "expires_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tread.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Query Parameters

​
filter[dispatch_number_ids]
array

The associated DispatchNumber IDs

​
filter[job][company_ids]
array

The associated Company IDs for the Job

​
filter[job][customer_account_ids]
array

The associated Customer Account IDs for the Job

​
filter[job][driver_ids]
array

The assigned Driver IDs for the Job

​
filter[job][dropoff_site_ids]
array

The associated Dropoff Site IDs for the Job

​
filter[job][end_date]
string

End date range for Job.job_start_at

​
filter[job][equipment_ids]
array

The associated Equipment IDs for the Job

​
filter[job][external_ids]
array

The associated External Project IDs for the Job

​
filter[job][material_ids]
array

The associated Material IDs for the Job

​
filter[job][pickup_site_ids]
array

The associated Pickup Site IDs for the Job

​
filter[job][project_ids]
array

The associated Project IDs for the Job

​
filter[job][service_ids]
array

The associated Service IDs for the Job

​
filter[job][site_types]
array

SiteType enum filters for the Job (see SiteType enum for the list of values)

​
filter[job][start_date]
string

Start date range for Job.job_start_at

​
filter[job][states]
array

Job states

​
filter[job][vendor_account_ids]
array

The associated Vendor Account IDs for the Job

​
search[job][datagrid]
string

Search string for datagrid queries

​
page[after]
string

The cursor to start paginating after

​
page[before]
string

The cursor to stop paginating at

​
page[limit]
integer<int32>
default:25

The maximum number of paginated results to return

Required range: x <= 100
​
facet[search][query]
string

The typeahead search query. Matches on the models's name field

​
facet[filter][waypoint][type]
enum<string>

A Waypoint type to filter on. Can be omitted to return all.

Available options:
pickup,
drop_off

Response

OK

​
data
Site-Read · object[]
required