---
title: "Get a properties list"
method: GET
path: "/inventory/v0-nsfw/properties"
tags: ["Property"]
---

# Get a properties list

`GET /inventory/v0-nsfw/properties`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/inventory/v0-nsfw/properties`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`

Get the list of properties.<br>You need to be authorized (no particular scope required)

## Query parameters

- `status` string[]
- `includeArchived` boolean
- `countryCode` string[]
- `propertyIds` string[]
- `pageNumber` integer
- `pageSize` integer
- `expand` string[]

## Response `200`

Return all properties.

- PropertyListModel
  - `properties` PropertyItemModel[], required: List of properties
    - `id` string, required: The property id
    - `code` string, required: The code for the property that can be shown in reports and table views
    - `propertyTemplateId` string, nullable: The id of the property used as a template while creating the property
    - `isTemplate` boolean, required: Whether the property can be used as a template for other properties
    - `name` string, required: The name for the property
    - `description` string, nullable: The description for the property
    - `companyName` string, required: The legal name of the company running the property.
    - `managingDirectors` string, nullable: The managing director(s) of the company, as they should appear on invoices
    - `commercialRegisterEntry` string, required: The entry in the Commercial Register of the company running the property, as it should appear on invoices
    - `taxId` string, required: The Tax-ID of the company running the property, as it should appear on invoices
    - `location` AddressModel, required
      - `addressLine1` string, required
      - `addressLine2` string, nullable
      - `postalCode` string, required
      - `city` string, required
      - `regionCode` string, nullable
      - `countryCode` string, required
    - `bankAccount` BankAccountModel
      - `iban` string, nullable
      - `bic` string, nullable
      - `bank` string, nullable
    - `paymentTerms` object, required: The payment terms used for all rate plans
    - `timeZone` string, required: The time zone name of the property from the IANA Time Zone Database. (see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
    - `currencyCode` string, required: The currency a property works with.
    - `created` string, date-time, required: Date of creation<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `status` 'Test' | 'Live', required: The status of the property
    - `isArchived` boolean, required: Is the property archived
    - `actions` ActionModelPropertyActionNotAllowedPropertyActionReason[], nullable: The list of actions for this property
      - `action` 'Delete' | 'Archive' | 'SetLive' | 'Reset', required
      - `isAllowed` boolean, required
      - `reasons` ActionReasonModelNotAllowedPropertyActionReason[], nullable
        - `code` 'DeleteNotAllowedForPropertyNotInStatusTest' | 'ArchiveNotAllowedForPropertyNotInStatusLive' | 'ArchiveNotAllowedForPropertyWhichIsAlreadyArchived' | 'SetToLiveNotAllowedForPropertyNotInStatusTest' | 'SetToLiveNotAllowedForPropertyInNonLiveAccount' | 'ResetNotAllowedForPropertyNotInStatusTest', required
        - `message` string, required
  - `count` integer, required: Total count of items

## Other responses

- `204`: There are no properties found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

## Changes

- **2026-10-05** `64434c68f85d`: 1 info
  - added the new optional `query` request parameter `propertyIds`

[Operation history](https://skmtc.dev/apaleo/apis/apaleo-inventory-api-not-safe-for-work/changes/inventory/v0-nsfw/properties/get.md)

---

[API](https://skmtc.dev/apaleo/apis/apaleo-inventory-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-inventory-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-inventory-api-not-safe-for-work/revisions/64434c68f85d?raw)