Get all yards configs including carrierIds

GET /api/automated-billing/config/yard/view/carrierIds

Retrieve the billing configurations for all yards in the organization including the carrierIds of all their configured carriers

Responses

  • default application/json

    List of yard configurations with the list of configured carrierIds

    Hide response attributes Show response attributes object
    • id integer(int64)

      Unique identifier of the yard configuration

    • yard_id integer(int64)

      Identifier of the yard

    • enabled boolean

      Indicates if the yard configuration is enabled

    • carrier_ids array[object]

      List of carrier identifiers that have configurations associated with the yard

      Hide carrier_ids attribute Show carrier_ids attribute object
      • carrier_id integer(int64)

        Identifier of the carrier associated with this configuration

    • Timestamp when the configuration was last modified

    • Username of the last modifier of this configuration

  • Not Authorized

  • Not Allowed

GET /api/automated-billing/config/yard/view/carrierIds
curl \
 -X GET https://api-dev.gatego.io/api/automated-billing/config/yard/view/carrierIds
Response examples (default)
[
  {
    "id": 1,
    "yard_id": 100,
    "enabled": true,
    "carrier_ids": [
      {
        "carrier_id": 250
      }
    ],
    "last_modified_at": "2023-04-06T11:25:42Z",
    "last_modified_by": "355c30f0-96d2-4dbe-bfe8-f8dd9eb7f778"
  }
]