List Carrier Accounts

The carrier list endpoint returns a list of carrier-accounts that you have setup in your Carriyo account. A carrier account can be inactive if it is not in use.

By default, the endpoint returns all active and inactive carrier accounts. The status query parameter can be passed to return carrier accounts based on the status. You can pass the following values to the status parameter.

  • active
  • inactive
  • deleted

Inactive carrier accounts cannot be used for booking. Hence you may want to only fetch active carrier accounts by passing query parameter of status=active.

SecurityOAuth2
Request
query Parameters
status
string
Enum: "active" "inactive" "deleted"
header Parameters
x-api-key
string
tenant-id
string
Content-Type
string
Default: application/json
Responses
200
get/carrier-accounts
Request samples
Response samples
application/json
[
  • {
    }
]