---
title: "Get a property"
method: GET
path: "/inventory/v1/properties/{id}"
tags: ["Property"]
---

# Get a property

`GET /inventory/v1/properties/{id}`

Get a property by id.<br>You need to be authorized (no particular scope required)

## Path parameters

- `id` string, required

## Query parameters

- `languages` string[]
- `expand` string[]

## Response `200`

Return all the property data.

- PropertyModel — With this request you can create a new property
  - `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` object, required — The name for the property
  - `description` object, 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

## Other responses

- `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.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-inventory-api.md) · [All operations](https://skmtc.dev/apaleo/apis/apaleo-inventory-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apaleo/apaleo-inventory-api/revisions/a2846f52cdfb/schema)
