List Facilities

Get a list of facilities, optionally filtered.

SecurityAPIKeyHeader

Request

query Parameters

point_of_contact_user_id	string (Point Of Contact User Id) Filter facilities by point of contact user ID
page	integer (Page) >= 1 Default: 1
limit	integer (Limit) [ 1 .. 1000 ] Default: 50
sort	string (Sort)
include	Array of strings (FacilityIncludeQueryOptionEnum) Include child entities that are not returned by default Items Enum: "DOCKS" "DOCK_COUNT" "CONTACT_COUNT" "LOAD_TYPE_COUNT"

Responses

200

Successful Response

Response Schema: application/json

required	Array of objects (Data)
total_count required	integer (Total Count)

400

Validation Error

get/facilities

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"data": [{"name": "string",
"location_type": "AIRPORT",
"address": {"line_1": "string",
"line_2": "string",
"line_3": "string",
"locality": "string",
"country": "US CN IN ID PK BR NG BD RU",
"region": "TX CA FL NY PA IL OH GA",
"postal_code": "string",
"timezone": "America/Chicago",
"geolocation": {"latitude": -90,
"longitude": -180
},
"formatted_address": "string"
},
"facility_services": ["RESTROOMS"
],
"external_reference": "string",
"notes": "string",
"carrier_instructions": "string",
"disclaimers": "string",
"appointment_lead_time_duration": "P1DT23H30M4.000000S",
"late_appointment_threshold_duration": "P1DT23H30M4.000000S",
"first_appointment_start_time": "14:15:22Z",
"last_appointment_end_time": "14:15:22Z",
"exclude_dock_assignment_from_appointment_scheduling": true,
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"dock_count": 0,
"contact_count": 0,
"load_type_count": 0,
"docks": [{"name": "string",
"color": "string",
"total_max_concurrent_appointments": 10000,
"id": "string",
"facility_id": "string"
}
]
}
],
"total_count": 0
}