Skip to content

Get 'BrfApartment'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
GET
/objects/spaces/spaces/brfapartment/{pk}/
curl -i -X GET \
  'https://dev.api.pigello.io/objects/spaces/spaces/brfapartment/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

buildingobject(Building)required
organizationobject or null(Organization)
custom_idstring or null, <= 128 characters
created_atstring, (date-time)read-only
landlord_custom_idstring or null, <= 255 characters
popular_namestring or null, <= 255 characters
addressobject or null(Address)

Content Type: common.address

usable_areanumber or null, (float)
bi_areanumber or null, (float)
archivedboolean
floorsArray of integers or null, (int32), unique
tempered_areanumber or null, (float)
financial_handlerobject or null(Company)
categorystring or null, <= 64 characters

Additional Validation Information:

Enum Descriptions:

  • PX_1_ROK - Px 1 Rok

  • PX_1_5_ROK - Px 1 5 Rok

  • PX_2_ROK - Px 2 Rok

  • PX_2_5_ROK - Px 2 5 Rok

  • PX_3_ROK - Px 3 Rok

  • PX_3_5_ROK - Px 3 5 Rok

  • PX_4_ROK - Px 4 Rok

  • PX_4_5_ROK - Px 4 5 Rok

  • PX_5_ROK - Px 5 Rok

  • PX_5_5_ROK - Px 5 5 Rok

  • PX_6_ROK - Px 6 Rok

  • PX_6_5_ROK - Px 6 5 Rok

  • PX_7_ROK - Px 7 Rok

  • PX_7_5_ROK - Px 7 5 Rok

  • PX_8_ROK - Px 8 Rok

  • PX_8_5_ROK - Px 8 5 Rok

  • PX_9_ROK - Px 9 Rok

  • PX_9_5_ROK - Px 9 5 Rok

  • PX_10_ROK - Px 10 Rok

  • PX_10_5_ROK - Px 10 5 Rok

  • PX_11_ROK - Px 11 Rok

  • PX_11_5_ROK - Px 11 5 Rok

  • PX_12_ROK - Px 12 Rok

  • PX_12_5_ROK - Px 12 5 Rok

  • PX_13_ROK - Px 13 Rok

  • PX_13_5_ROK - Px 13 5 Rok

  • PX_14_ROK - Px 14 Rok

  • PX_14_5_ROK - Px 14 5 Rok

  • PX_15_ROK - Px 15 Rok

  • PX_15_5_ROK - Px 15 5 Rok

  • PX_16_ROK - Px 16 Rok

  • PX_16_5_ROK - Px 16 5 Rok

  • PX_1_ROKV - Px 1 Rokv

  • PX_1_5_ROKV - Px 1 5 Rokv

  • PX_2_ROKV - Px 2 Rokv

  • PX_2_5_ROKV - Px 2 5 Rokv

  • PX_3_ROKV - Px 3 Rokv

  • PX_3_5_ROKV - Px 3 5 Rokv

  • PX_4_ROKV - Px 4 Rokv

  • PX_4_5_ROKV - Px 4 5 Rokv

  • PX_5_ROKV - Px 5 Rokv

  • PX_1_PENTRY - Px 1 Pentry

  • PX_1_5_PENTRY - Px 1 5 Pentry

  • PX_2_PENTRY - Px 2 Pentry

  • PX_2_5_PENTRY - Px 2 5 Pentry

  • PX_3_PENTRY - Px 3 Pentry

  • PX_1_RO - Px 1 Ro

  • PX_1_5_RO - Px 1 5 Ro

  • PX_2_RO - Px 2 Ro

  • PX_2_5_RO - Px 2 5 Ro

  • PX_3_RO - Px 3 Ro

  • PX_1_ROS - Px 1 Ros

  • PX_1_5_ROS - Px 1 5 Ros

  • PX_2_ROS - Px 2 Ros

  • PX_2_5_ROS - Px 2 5 Ros

  • PX_3_ROS - Px 3 Ros

  • BAA - Baa

  • BAD - Bad

  • CAN - Can

  • PX_INDUSTRY - Px Industry

  • PX_RESTAURANT - Px Restaurant

  • BAE - Bae

  • PX_BAKERY - Px Bakery

  • PX_BARBER - Px Barber

  • PX_HAIRDRESSER - Px Hairdresser

  • XBB - Xbb

  • BAB - Bab

  • XAB - Xab

  • CBD - Cbd

  • PX_GYM - Px Gym

  • PX_WORKSHOP - Px Workshop

  • BED - Bed

  • BHA - Bha

  • PX_VETERINARY - Px Veterinary

  • PX_LIBRARY - Px Library

  • PX_ATM - Px Atm

  • PX_BANK - Px Bank

  • PX_CINEMA - Px Cinema

  • PX_CAFE - Px Cafe

  • PX_KINDERGARDEN - Px Kindergarden

  • PX_CONFERENCE - Px Conference

  • PX_SHARED_OFFICE - Px Shared Office

  • PX_TOWER - Px Tower

  • PX_MUSEUM - Px Museum

  • BEB - Beb

  • XBA - Xba

  • ACA - Aca

  • PX_DENTIST - Px Dentist

  • PX_GROUP_LIVING - Px Group Living

  • PX_HIGH_WAREHOUSE - Px High Warehouse

  • PX_COLD_WAREHOUSE - Px Cold Warehouse

  • PX_LSS_LIVING - Px Lss Living

  • PX_HOUSE - Px House

  • PX_ELDERLY - Px Elderly

  • PX_CONSTRUCTION_HOUSING - Px Construction Housing

  • PX_ANTENNA - Px Antenna

  • PX_RESIDENTIAL - Px Residential

  • PX_BOAT_HOUSE - Px Boat House

  • PX_DAILY_OPERATIONS - Px Daily Operations

  • PX_FINANCIAL_BUILDING - Px Financial Building

  • PX_ASSOCIATION - Px Association

  • PX_STORAGE - Px Storage

  • PX_MANAGEMENT - Px Management

  • PX_HOTEL - Px Hotel

  • PX_BASEMENT - Px Basement

  • PX_LABORATORY - Px Laboratory

  • PX_BARN - Px Barn

  • PX_STOCK - Px Stock

  • PX_DOCTOR_OFFICE - Px Doctor Office

  • PX_GROCERY_STORE - Px Grocery Store

  • PX_ENVIRONMENT_ROOM - Px Environment Room

  • PX_PAVILION - Px Pavilion

  • PX_STAFF - Px Staff

  • PX_PARKING - Px Parking

  • PX_POSTAL_BOX - Px Postal Box

  • PX_POSTAL_MANAGEMENT - Px Postal Management

  • PX_PUMP_HOUSE - Px Pump House

  • PX_ADVERTISING - Px Advertising

  • PX_RESCUE_STATION - Px Rescue Station

  • PX_SERVICE_HOUSE - Px Service House

  • PX_HOSTPITAL - Px Hospital

  • PX_SIGN - Px Sign

  • PX_ATTIC - Px Attic

  • PX_OTHER - Px Other

  • PX_BIKE_STORAGE - Px Bike Storage

  • PX_FOOD_CELLAR - Px Food Cellar

  • PX_SPORTS_HALL - Px Sports Hall

  • PX_BEAUTY_CARE - Px Beauty Care

  • PX_MEDICAL_CARE - Px Medical Care

  • PX_WELLNESS_CARE - Px Wellness Care

  • PX_COMMUNITY_PREMISES - Px Community Premises

Enum:"PX_1_ROK""PX_1_5_ROK""PX_2_ROK""PX_2_5_ROK""PX_3_ROK""PX_3_5_ROK""PX_4_ROK""PX_4_5_ROK""PX_5_ROK""PX_5_5_ROK"
apartment_idstring or null, <= 4 characters'^\d{4}$'
tenantobject or null(Tenant)read-only
reparation_fund_quotanumber or null, (float)
quotanumber, (float)
placement_feenumber, (float)
investment_capitalnumber, (float)
placement_datestring or null, (date)
realtor_image_common_info_textstring or null
custom_dimension_valuestring or null, <= 255 characters
bi_tenantsArray of objects(Tenant)read-only
reparation_fund_quota_feesArray of objects(QuotaFee)
tagsanyread-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
Response
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "landlord_custom_id": "string",
  "popular_name": "string",
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization": { … },
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "care_of": "string",
    "attention": "string",
    "street": "string",
    "street_number": "string",
    "postal_code": "string",
    "city": "string",
    "country": "string",
    "longitude": -180,
    "latitude": -90
  },
  "usable_area": 0.1,
  "bi_area": 0.1,
  "archived": true,
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "floors": [
    0
  ],
  "tempered_area": 0.1,
  "financial_handler": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "category": "PX_1_ROK",
  "apartment_id": "stri",
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "reparation_fund_quota": 0.1,
  "quota": 0.1,
  "placement_fee": 0.1,
  "investment_capital": 0.1,
  "placement_date": "2019-08-24",
  "realtor_image_common_info_text": "string",
  "custom_dimension_value": "string",
  "bi_tenants": [
    { … }
  ],
  "reparation_fund_quota_fees": [
    { … }
  ],
  "tags": null,
  "customer_columns": null,
  "pending_monitor_approval_amount": null
}
© Pigello. All rights reserved.