API V3 – Check Your Load Announcement Quota

The /v3/loads/check/quota endpoint lets you get the number of load announcements that you have posted in the current month and the number remaining, according to your subscription plan.

For TMS integrators, this endpoint is useful to display this information within your UI as a courtesy feature. With this endpoint implemented, our mutual customer can see how many more BrokerCarrier load announcements they have in the current month without having to separately log into their BrokerCarrier dashboard.

Notes on this endpoint:

  1. Requires secret key. This endpoint must be called from the server side to avoid compromising your secret API key. Please do not use your secret key in client-side JavaScript.

HTTP request

Method
URL
GET

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
email
string
Email address of the VETCarriers user who is making the API call

Return values

This endpoint returns an object with the following keys and values.

Key
Type
Value
quota
object
{}
An object with the following fields:

{
integer
integer
integer
}
response
object
{}
An object with the following fields:

{
string
integer
integer
}

Example response

{
    "quota": {
        "used": 1654,
        "remaining": 346,
        "limit": 2000
    },
    "response": {
        "date_time": "2022-11-28 22:19:56 UTC",
        "timestamp": 1669673996,
        "status": 200
    }
}