Skip to main content
GET
/
orgs
/
{orgId}
/
available-carriers
Returns a list of available carriers
curl --request GET \
  --url https://api.zippendo.com/orgs/{orgId}/available-carriers \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "<string>",
    "slug": "<string>",
    "group": "<string>",
    "description": "<string>",
    "logo": "<string>",
    "learnMoreUrl": "<string>",
    "requiredFields": [
      {
        "name": "<string>",
        "key": "<string>",
        "type": "string",
        "description": "<string>",
        "options": [
          {
            "name": "<string>",
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "required": true
      }
    ],
    "optionalFields": [
      {
        "name": "<string>",
        "key": "<string>",
        "type": "string",
        "description": "<string>",
        "options": [
          {
            "name": "<string>",
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "required": true
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

Response

Default Response

name
string
required
slug
string
required
group
string
description
string
learnMoreUrl
string<uri>
requiredFields
object[]
optionalFields
object[]