The /v4/carriers/refresh/carrier/lists endpoint lets you refresh the index of named carrier lists that you have created in your BrokerCarrier Dashboard.
Notes on this endpoint:
- Authentication via header. To authenticate your API call, pass in your public API key with the X-Api-Key HTTP header.
HTTP Request
| Method | URL |
|---|---|
| GET | https://api.brokercarrier.com/v4/carriers/refresh/carrier/lists |
Required Parameters
None.
Example Response
Request: https://api.brokercarrier.com/v4/carriers/refresh/carrier/lists
The example response below shows a list containing two lists. Your real API calls may return much larger responses than this.
[
{
"name": "Nevada Reefer",
"carriers": 16,
"metadata": {
"created": {
"by": "Dave Garcia",
"date": "2024-02-08"
},
"edited": {
"by": "Dave Garcia",
"date": "2024-02-15"
}
}
},
{
"name": "Nevada Flatbed",
"carriers": 26,
"metadata": {
"created": {
"by": "Cindy Miller",
"date": "2024-02-28"
},
"edited": {
"by": "Cindy Miller",
"date": "2024-03-03"
}
}
}
]