The /v4/carriers/refresh/network endpoint lets you retrieve a portable overview of your onboarded carriers, beginning from a specified onboarding date.
This endpoint is most useful when you first add your BrokerCarrier API key to your integrated TMS. If you have a large number of onboarded carriers in BrokerCarrier that have not been ported to your system, you can use this endpoint to batch-import your entire carrier network.
In addition, you can use this endpoint as a convenient way to refresh your carrier list daily by specifying the current date or the previous day’s date as the beginning point.
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/refresh/network |
Required Parameters
| Name | Type | Value(s) |
|---|---|---|
| status | string |
One of: active, pending, dnu
|
| start_date | string |
Date formatted as YYYY-MM-DD |
Example Response
Request: https://api.brokercarrier.com/v4/carriers/refresh/network?start_date=2024-03-01
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": "active",
"carriers": [
{
"contact": {
"phone": "8137239590",
"email": "jgfreightllc23@gmail.com",
"mailing_address": {
"street": "2288 N VALRICO RD",
"city": "SEFFNER",
"state": "FL",
"zip": "33584-5528"
},
"physical_address": {
"street": "2288 N VALRICO RD",
"city": "SEFFNER",
"state": "FL",
"zip": "33584"
}
},
"dispatcher": {
"name": "EVELYN GUERRA",
"email": "jgfreightllc23@gmail.com",
"phone": "8137239590"
},
"dot": {
"business_name": "JG FREIGHT LLC",
"dot_number": "4171463",
"authority": {
"prefix": "MC",
"number": 1604546,
"tickets": [
"common"
],
"authorized": [
"property"
]
}
},
"equipment": [
"flatbed"
],
"lane_preferences": [
{
"from": "BRISTOL, VA",
"to": "OHIO, IL"
}
],
"onboarded": "2024-02-05",
payment": {
"poc": {
"name": "EVELYN GUERRA",
"phone": "8137239590",
"email": "jgfreightllc23@gmail.com"
},
"remit_to": {
"address": "2288 N VALRICO RD",
"city": "SEFFNER",
"state": "FL",
"zip": "33584"
},
"details": {
"ein": "991234567",
"ach" {
"routing": "[ENCRYPTED-VALUE]",
"account": "[ENCRYPTED-VALUE]"
}
}
},
"services": [
"gps"
]
},
{
"contact": {
"phone": "5176149050",
"email": "transport@mqtransport.com",
"mailing_address": {
"street": "4025 HOLT ROAD BLDG C",
"city": "HOLT",
"state": "MI",
"zip": "48842"
},
"physical_address": {
"street": "4025 HOLT ROAD BLDG C",
"city": "HOLT",
"state": "MI",
"zip": "48842"
}
},
"dispatcher": {
"name": "HUE YANG",
"email": "transport@mqtransport.com",
"phone": "5176149050"
},
"dot": {
"business_name": "M&Q TRANSPORTATION INC",
"dot_number": "1684858",
"authority": {
"prefix": "MC",
"number": 618991,
"tickets": [
"common"
],
"authorized": [
"property"
]
}
},
"equipment": [
"conestoga",
"dry van",
"flatbed"
],
"factoring": {
"company": "Consultants Factoring",
"poc_name": "BOB SLYDELL",
"document": {
"title": "Notice of Assigment",
"filename": "verylongfilenamethatyoucanaccessfromanotherendpoint.pdf"
}
},
"lane_preferences": [
{
"from": "LANSING, MI",
"to": "INDIANAPOLIS, IN"
}
],
"onboarded": "2024-02-02",
"services": [
"expedited",
"gps",
"ltl",
"power-only semi"
]
}
]
}