v1

latestOpenAPI 3.1.02026-07-246246106.8 KB
Book It Now

Search for Carriers within a specific Carrier Group

post/groupmanagement/v2/carrier/search/{groupId}

Path parameters

groupIdstring required

Request body

totalPagesnumber
pageNumbernumber
pageSizenumber
totalItemCountnumber
resultsTruncatedboolean

Example request

{
  "totalPages": 1,
  "pageNumber": 1,
  "pageSize": 100,
  "totalItemCount": 1
}

Response

Successful Response

Example response

{
  "pagination": {
    "totalPages": 1,
    "pageNumber": 1,
    "pageSize": 100,
    "totalItemCount": 1
  },
  "data": [
    {
      "carrierProfileId": "941f5fce-2de6-e911-aa12-9f2efc3a92b4",
      "createdDateTime": "2019-10-03T22:33:15",
      "tenderEnabled": true,
      "status": 1,
      "customData": [
        {
          "key": "My_Custom_Key",
          "value": "My_Custom_Value"
        }
      ],
      "companyName": "Haulers"
    }
  ]
}