Get apartment - STR Uploader API

GET

apartments

{id}

Get apartment

curl --request GET \
  --url https://str.keroshospitality.com/api/v1/apartments/{id} \
  --header 'Authorization: Bearer <token>'

{
  "apartment": {
    "id": 42,
    "name": "Seaside Villa",
    "address": "123 Beach Road",
    "registryId": "00002087410",
    "ownerId": 42,
    "createdAt": "2025-01-01T12:00:00Z",
    "updatedAt": "2025-01-01T12:00:00Z"
  },
  "requestId": "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890"
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

integer

required

Apartment ID

Response

Apartment retrieved successfully

apartment

object

Show child attributes

requestId

string

Example:

"a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890"

Delete apartmentDelete apartment by ID. ### Allowed Roles: `admin`, `str-uploader`

Get apartment

curl --request GET \
  --url https://str.keroshospitality.com/api/v1/apartments/{id} \
  --header 'Authorization: Bearer <token>'

{
  "apartment": {
    "id": 42,
    "name": "Seaside Villa",
    "address": "123 Beach Road",
    "registryId": "00002087410",
    "ownerId": 42,
    "createdAt": "2025-01-01T12:00:00Z",
    "updatedAt": "2025-01-01T12:00:00Z"
  },
  "requestId": "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890"
}