BObookingexperts
Administrations

GET administrations

Changed on

Returns all administrations accessible for the current subscription

get/v3/administrations

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[administration]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[email]string

Filter on email

filter[phone]string

Filter on phone

filter[website]string

Filter on website

filter[native_currency]string

Filter on native_currency

filter[address]string

Filter on address

filter[city]string

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

filter[description]string

Filter on description

filter[surroundings_description]string

Filter on surroundings_description

filter[tin]string

Filter on tin

filter[available_locales]string

Filter on available_locales

filter[native_locale]string

Filter on native_locale

filter[timezone]string

Filter on timezone

filter[invoice_email]string

Filter on invoice_email

filter[invoice_phone]string

Filter on invoice_phone

filter[invoice_address]string

Filter on invoice_address

filter[invoice_postalcode]string

Filter on invoice_postalcode

filter[invoice_city]string

Filter on invoice_city

filter[invoice_country_code]string

Filter on invoice_country_code

filter[guest_list_group]string

Filter on guest_list_group

filter[guest_accepted_document_type]string

Filter on guest_accepted_document_type

filter[guest_identification_required]string

Filter on guest_identification_required

filter[ask_for_guest_gender]string

Filter on ask_for_guest_gender

filter[ask_for_guest_address]string

Filter on ask_for_guest_address

filter[ask_for_guest_postal_code]string

Filter on ask_for_guest_postal_code

filter[ask_for_guest_city]string

Filter on ask_for_guest_city

filter[ask_for_guest_country]string

Filter on ask_for_guest_country

filter[ask_for_guest_email]string

Filter on ask_for_guest_email

filter[ask_for_guest_phone]string

Filter on ask_for_guest_phone

filter[ask_for_guest_profession]string

Filter on ask_for_guest_profession

filter[ask_for_guest_signature]string

Filter on ask_for_guest_signature

filter[ask_for_fellow_guest_gender]string

Filter on ask_for_fellow_guest_gender

filter[ask_for_fellow_guest_address]string

Filter on ask_for_fellow_guest_address

filter[ask_for_fellow_guest_postal_code]string

Filter on ask_for_fellow_guest_postal_code

filter[ask_for_fellow_guest_city]string

Filter on ask_for_fellow_guest_city

filter[ask_for_fellow_guest_country]string

Filter on ask_for_fellow_guest_country

filter[ask_for_fellow_guest_email]string

Filter on ask_for_fellow_guest_email

filter[ask_for_fellow_guest_phone]string

Filter on ask_for_fellow_guest_phone

filter[ask_for_fellow_guest_profession]string

Filter on ask_for_fellow_guest_profession

filter[ask_for_fellow_guest_signature]string

Filter on ask_for_fellow_guest_signature

filter[default_option_validity]string

Filter on default_option_validity

filter[latitude]string

Filter on latitude

filter[longitude]string

Filter on longitude

filter[allow_multi_reservation_bookings_through_api]string

Filter on allow_multi_reservation_bookings_through_api

filter[accounting_closed_upto]string

Filter on accounting_closed_upto

filter[enable_license_plates]string

Filter on enable_license_plates

filter[iban]string

Filter on iban

filter[bic]string

Filter on bic

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[checkin_timetable]string

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

filter[checkout_timetable]string

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

filter[payment_handlers]string

Filter on payment_handlers. 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

AdministrationCollectionResponse

Example response

{
  "data": [
    {
      "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"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "city",
      "attributes": {
        "country_code": "NL"
      },
      "relationships": {
        "region": {
          "data": {
            "type": "region"
          }
        },
        "regions": {
          "data": [
            {
              "type": "region"
            }
          ]
        }
      }
    }
  ]
}

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