BObookingexperts
Channel Channels

GET channels

Changed on

Returns all channels accessible for the current subscription

get/v3/channels

Request

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[channel]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[kind]string

Filter on kind

filter[requires_night_prices]string

Filter on requires_night_prices

filter[rent_invoiced_to]string

Filter on rent_invoiced_to

filter[costs_invoiced_to]string

Filter on costs_invoiced_to

filter[use_costs_invoiced_to]string

Filter on use_costs_invoiced_to

filter[extras_invoiced_to]string

Filter on extras_invoiced_to

filter[use_extras_invoiced_to]string

Filter on use_extras_invoiced_to

filter[supports_group_details]string

Filter on supports_group_details

filter[confirm_reservations]string

Filter on confirm_reservations

filter[auto_deliver_invoices]string

Filter on auto_deliver_invoices

filter[customer_invoice_payable_on_park]string

Filter on customer_invoice_payable_on_park

filter[archived]string

Filter on archived

filter[temporary_booking_validity_in_hours]string

Filter on temporary_booking_validity_in_hours

filter[price_factor]string

Filter on price_factor

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[administration]string

Filter on administration. Specify a comma separated list of IDs to filter on.

filter[application]string

Filter on application. Specify a comma separated list of IDs to filter on.

filter[brand]string

Filter on brand. Specify a comma separated list of IDs to filter on.

filter[contact]string

Filter on contact. Specify a comma separated list of IDs to filter on.

filter[guest_payment_policy]string

Filter on guest_payment_policy. Specify a comma separated list of IDs to filter on.

filter[channel_payment_policy]string

Filter on channel_payment_policy. Specify a comma separated list of IDs to filter on.

filter[excluded_costs]string

Filter on excluded_costs. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

ChannelCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "channel",
      "attributes": {
        "name": "Tours Inc.",
        "email": "info@tours.inc",
        "available_currencies": [
          "EUR",
          "USD"
        ],
        "fixed_attributes": [
          "kind",
          "requires_night_prices"
        ]
      },
      "relationships": {
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "application": {
          "data": {
            "type": "application"
          }
        },
        "brand": {
          "data": {
            "type": "brand"
          }
        },
        "contact": {
          "data": {
            "type": "contact"
          }
        },
        "guest_payment_policy": {
          "data": {
            "type": "payment_policy"
          }
        },
        "channel_payment_policy": {
          "data": {
            "type": "payment_policy"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "administration",
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "interactive_map": {
          "data": {
            "type": "interactive_map"
          }
        },
        "payment_handlers": {
          "data": [
            {
              "type": "payment_handler"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      response property included/items/anyOf[Contact]/attributes/receive_newsletter deprecated