strategy-carriers

List strategy carriers

Changed on

Returns a paginated list of strategy carriers scoped to the caller account and parent strategy.

get/api/v1/strategies/{strategyId}/carriers

Request

Path parameters

strategyIdstring uuid required
Example:01920000-0000-7000-8000-000000000000

Parent strategy identifier (UUID).

Query parameters

activeboolean
carrier_idstring
delivery_type_codestring
capabilitystring[]
qstring
pagenumber
limitnumber
sortBystring
sortOrderstring

Response

Paginated list of strategy carriers.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

    • info

      added the new optional query request parameter active

    • info

      added the new optional query request parameter capability

    • info

      added the new optional query request parameter carrier_id

    • info

      added the new optional query request parameter delivery_type_code

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter q

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortOrder

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter active

    • warning

      deleted the query request parameter capability

    • warning

      deleted the query request parameter carrier_id

    • warning

      deleted the query request parameter delivery_type_code

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter q

    • warning

      deleted the query request parameter sortBy

    • warning

      deleted the query request parameter sortOrder