Get list of Properties API

List properties

get

/properties

List properties. Results are paginated; the meta block carries the page, limit, total and ordering. Without pagination[…] and order[…], the first 10 properties are returned ordered by title ascending.

Authorizations

user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Query parameters

filter[title]stringOptional

Return only properties with exactly this title.

filter[city]stringOptional

Return only properties in exactly this city.

filter[country]string · min: 2 · max: 2Optional

ISO 3166-1 alpha-2 country code.

Example: GB

pagination[page]integer · int32 · min: 1Optional

Page to return, counted from 1.

pagination[limit]integer · int32 · min: 1 · max: 100Optional

Number of items per page. Maximum is 100.

order[title]string · enumOptional

Sort direction for list results.

Possible values:

order[inserted_at]string · enumOptional

Sort direction for list results.

Possible values:

Responses

200

The request has succeeded.

application/json

JSON:API document wrapping a collection of resources with pagination meta.

401

Authentication credentials are missing or invalid.

application/json

422

The request has missing or invalid arguments; details lists the messages per argument.

application/json

get/properties

GET /api/v1/properties HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "type": "property",
      "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
      "attributes": {
        "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "is_active": true,
        "is_demo": true,
        "expected_removal_date": "2026-12-31",
        "acc_channels_count": 1,
        "property_category": "hotel",
        "max_count_of_room_types": 20,
        "max_count_of_rate_plans": 200,
        "max_count_of_occupancies": 8,
        "max_count_of_users": 20,
        "title": "Demo Hotel",
        "currency": "GBP",
        "email": "[e-mail]",
        "phone": "[phone]",
        "zip_code": "XXX XXX",
        "country": "GB",
        "state": "Wales",
        "city": "Cardiff",
        "address": "123 High Street",
        "longitude": "-0.2416781",
        "latitude": "51.5285582",
        "timezone": "Europe/London",
        "property_type": "apart_hotel",
        "logo_url": "https://example.com/logo.png",
        "website": "https://example.com",
        "hotel_policy_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "default_cancellation_policy_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "default_tax_set_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "location_precision": 1,
        "settings": {
          "allow_availability_autoupdate_on_confirmation": true,
          "allow_availability_autoupdate_on_modification": true,
          "allow_availability_autoupdate_on_cancellation": true,
          "min_stay_type": "both",
          "state_length": 500,
          "cut_off_time": "00:00:00",
          "cut_off_days": 0,
          "max_day_advance": 365,
          "min_price": "100.00",
          "max_price": "300.00"
        },
        "content": {
          "description": "A lovely hotel in the city center.",
          "important_information": "Check-in from 3 PM. No pets allowed.",
          "photos": [
            {
              "id": "cc673f90-8d65-498d-9ee7-b4b39f8df3ee",
              "property_id": "52397a6e-c330-44f4-a293-47042d3a3607",
              "room_type_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "kind": "photo",
              "position": 0,
              "author": "John Doe",
              "description": "Room View",
              "url": "https://images.channex.io/1747b751-28c0-47db-742a-40f62a186a00/"
            }
          ]
        }
      },
      "relationships": {
        "users": {
          "data": [
            {
              "type": "user",
              "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "attributes": {
                "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
                "name": "Channex User",
                "email": "[e-mail]"
              }
            }
          ]
        },
        "groups": {
          "data": [
            {
              "type": "group",
              "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "attributes": {
                "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
                "title": "My Hotel"
              }
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "order_by": "inserted_at",
    "order_direction": "desc"
  }
}