The /v4/carriers/load/carrier/list endpoint lets you retrieve an portable overview of your onboarded carriers that you have added to a named carrier list in your dashboard.
This endpoint is a convenient way to refresh your carrier lists multiple times per day as your organize your carriers by lane, equipment, etc.
Notes on this endpoint:
- Potential for large responses. This endpoint can potentially return very large responses. The complete profile of a single carrier is typically about 3KB, and there can potentially be thousands of carriers in your network. For this reason, we recommend handling requests to this endpoint asynchronously.
- 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/load/carrier/list |
Required Parameters
| Name | Type | Value(s) |
|---|---|---|
| list_name | string |
The name of your list, not case sensitive |
Example Response
Request: https://api.brokercarrier.com/v4/carriers/load/carrier/list?list_name=texas%20reefer
The example response below shows a list containing two carriers. Your real API calls will return much larger responses than this.
In the first example carrier, the payment field shows a fictional example of the data that is returned for a carrier that does not use a factoring company. The payment->details->ach->routing and payment->details->ach->account fields are encrypted using your secret key. Please contact us when you reach this point, and we will assist you with setting up your secret key for use in decrypting these values.
In the second example carrier, the factoring field shows a fictional example of the data that is returned for a carrier that uses a factoring company.
{
"list_name": "Texas Reefer",
"carriers": [
{
"contact": {
"phone": "8328882889",
"email": "doug@xcelltransport.us",
"mailing_address": {
"street": "6140 HWY 6 SOUTH STE 208",
"city": "MISSOURI CITY",
"state": "TX",
"zip": "77459"
},
"physical_address": {
"street": "4621 GASMER DR",
"city": "HOUSTON",
"state": "TX",
"zip": "77035"
}
},
"dispatcher": {
"name": "DOUG TURNER",
"email": "doug@xcelltransport.us",
"phone": "8328882889"
},
"dot": {
"business_name": "XCELL TRANSPORT & LOGISTICS LLC",
"dot_number": "3644211",
"authority": {
"prefix": "MC",
"number": 1253508,
"tickets": [
"common"
],
"authorized": [
"property"
]
}
},
"equipment": [
"dry van",
"flatbed",
"hot shot",
"reefer"
],
"lane_preferences": [
{
"from": "HOUSTON, TX",
"to": "HOUSTON, TX"
},
{
"from": "HOUSTON, TX",
"to": "SHREVEPORT, LA"
}
],
"onboarded": "2023-12-14",
payment": {
"poc": {
"name": "DOUG TURNER",
"phone": "8328882889",
"email": "doug@xcelltransport.us"
},
"remit_to": {
"address": "6140 HWY 6 SOUTH STE 208",
"city": "MISSOURI CITY",
"state": "TX",
"zip": "77459"
},
"details": {
"ein": "991234567",
"ach" {
"routing": "[ENCRYPTED-VALUE]",
"account": "[ENCRYPTED-VALUE]"
}
}
},
"services": [
"gps",
"power-only semi"
]
},
{
"contact": {
"phone": "8138084444",
"email": "gomezandsonstrucking@gmail.com",
"mailing_address": {
"street": "101 FREEDOM CIRCLE",
"city": "SAN BENITO",
"state": "TX",
"zip": "78586"
},
"physical_address": {
"street": "101 FREEDOM CIRCLE",
"city": "SAN BENITO",
"state": "TX",
"zip": "78586"
}
},
"dispatcher": {
"name": "RUBEN GOMEZ",
"email": "gomezandsonstrucking@gmail.com",
"phone": "8138084444"
},
"dot": {
"business_name": "GOMEZ & SON'S TRUCKING LLC",
"dot_number": "3482290",
"authority": {
"prefix": "MC",
"number": 1267130,
"tickets": [
"common"
],
"authorized": [
"property"
]
}
},
"equipment": [
"flatbed",
"reefer"
],
"factoring": {
"company": "Consultants Factoring",
"poc_name": "BOB SLYDELL",
"document": {
"title": "Notice of Assigment",
"filename": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf"
}
},
"lane_preferences": [
{
"from": "CHICAGO, IL",
"to": "NASHVILLE, TN"
},
{
"from": "DONNA, TX",
"to": "CHICAGO, IL"
}
],
"onboarded": "2023-11-10",
"services": [
"gps",
"refrigerated",
"tarps provided"
]
}
]
}