BObookingexperts
RentableSegments

GET rentable_segments

Changed on

Returns RentableSegments of the organization

get/v3/rentable_segments

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[rentable_segment]string

Fieldset. Specify a comma separated list of attributes to return

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[semantic_segment]string

Filter on semantic_segment

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

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

RentableSegmentCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "rentable_segment"
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new owners_managers_residence enum value to the /// response property for the response status

    • warning

      added the new parking_place enum value to the /// response property for the response status

    • warning

      added the new private_bathroom enum value to the /// response property for the response status

    • warning

      added the new recreational_vehicle enum value to the /// response property for the response 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