Skip to content
/
Bulk write 'Apartment'

Objects (2.0.0)

The 'Objects' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Parkingspot

Operations

Apartmenttargetaudience

Operations

Parkingspotvacancynotation

Operations

Industrialpremises

Operations

Industrialpremisesvacancylossnotation

Operations

Industrialpremisestargetaudience

Operations

Outdoorsectionterms

Operations

Industrialpremisesvacancynotation

Operations

Outdoorsectiontargetaudience

Operations

Commonarea

Operations

Industrialpremisesterms

Operations

Parkingspotvacancylossnotation

Operations

Outdoorsectionvacancynotation

Operations

Parkingspottargetaudience

Operations

Apartmentterms

Operations

Apartmentvacancylossnotation

Operations

Outdoorsectionvacancylossnotation

Operations

Parkingspotterms

Operations

Brfapartment

Operations

Apartment

Operations

List 'Apartment'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
customer_columnsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
landlordsArray of objects
tagsArray of objects
tenantsArray of objects
addressany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allowed_target_audiencesany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

apartment_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

archivedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

bi_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

bi_tenantsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

buildingany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

categoryany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_dimension_valueany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

financial_handlerany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

floorsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: empty, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

future_contractingany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

has_base_rent_vatany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

landlord_custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

popular_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

revenue_increase_created_at__lteany
revenue_increase_not_created__gteany
statusany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

subtenant_connection_stakeholder_type__inArray of objectswrite-only
subtenant_connection_status__inArray of objectswrite-only
tempered_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

tenantany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

termsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

usable_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/objects/spaces/spaces/apartment/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -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 query

Bodyapplication/jsonArray [
future_contractinginteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

buildingobject(Building)required
building.​idstring(uuid)
landlord_custom_idstring or null<= 255 characters
archivedboolean
financial_handlerobject or null(Company)
bi_tenantsArray of objects(Tenant)read-only
tagsanyread-only
custom_dimension_valuestring or null<= 255 characters
created_atstring(date-time)read-only
market_apartmentanyread-only
organizationobject or null(Organization)
floorsArray of integers or null(int32)unique
termsobject or null(Apartmentterms)
popular_namestring or null<= 255 characters
allowed_target_audiencesArray of objects(Apartmenttargetaudience)
apartment_idstring or null<= 4 characters'^\d{4}$'
tenantobject or null(Tenant)read-only
bi_areanumber or null(float)
categorystring or null<= 64 characters
Enum"PX_16_5_ROK""PX_1_ROK""PX_15_5_ROK""PX_1_5_RO""PX_14_ROK""PX_4_ROK""PX_3_ROS""PX_4_ROKV""PX_2_ROK""PX_3_5_ROKV"
tempered_areanumber or null(float)
has_base_rent_vatbooleanread-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
addressobject or null(Address)
custom_idstring or null<= 128 characters
usable_areanumber or null(float)
]
Response
application/json
[
  {
    "landlord_custom_id": "string",
    "archived": true,
    "financial_handler": { … },
    "bi_tenants": [ … ],
    "tags": null,
    "custom_dimension_value": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "market_apartment": null,
    "future_contracting": 0,
    "organization": { … },
    "status": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "floors": [ … ],
    "terms": { … },
    "popular_name": "string",
    "allowed_target_audiences": [ … ],
    "apartment_id": "stri",
    "building": { … },
    "tenant": { … },
    "bi_area": 0.1,
    "category": "PX_16_5_ROK",
    "tempered_area": 0.1,
    "has_base_rent_vat": true,
    "customer_columns": null,
    "pending_monitor_approval_amount": null,
    "address": { … },
    "custom_id": "string",
    "usable_area": 0.1
  }
]

Bulk write 'Apartment'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
buildingobject(Building)required
building.​idstring(uuid)
landlord_custom_idstring or null<= 255 characters
archivedboolean
financial_handlerobject or null(Company)
custom_dimension_valuestring or null<= 255 characters
organizationobject or null(Organization)
floorsArray of integers or null(int32)unique
termsobject or null(Apartmentterms)
popular_namestring or null<= 255 characters
allowed_target_audiencesArray of objects(Apartmenttargetaudience)
apartment_idstring or null<= 4 characters'^\d{4}$'
bi_areanumber or null(float)
categorystring or null<= 64 characters
Enum"PX_16_5_ROK""PX_1_ROK""PX_15_5_ROK""PX_1_5_RO""PX_14_ROK""PX_4_ROK""PX_3_ROS""PX_4_ROKV""PX_2_ROK""PX_3_5_ROKV"
tempered_areanumber or null(float)
addressobject or null(Address)
custom_idstring or null<= 128 characters
usable_areanumber or null(float)
]
curl -i -X POST \
  https://dev.api.pigello.io/objects/spaces/spaces/apartment/list/ \
  -H 'Content-Type: application/json' \
  -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' \
  -d '[
    {
      "landlord_custom_id": "string",
      "archived": true,
      "financial_handler": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_dimension_value": "string",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "floors": [
        0
      ],
      "terms": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "popular_name": "string",
      "allowed_target_audiences": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "apartment_id": "stri",
      "building": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "bi_area": 0.1,
      "category": "PX_16_5_ROK",
      "tempered_area": 0.1,
      "address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "usable_area": 0.1
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
future_contractinginteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

buildingobject(Building)required
building.​idstring(uuid)
landlord_custom_idstring or null<= 255 characters
archivedboolean
financial_handlerobject or null(Company)
bi_tenantsArray of objects(Tenant)read-only
tagsanyread-only
custom_dimension_valuestring or null<= 255 characters
created_atstring(date-time)read-only
market_apartmentanyread-only
organizationobject or null(Organization)
floorsArray of integers or null(int32)unique
termsobject or null(Apartmentterms)
popular_namestring or null<= 255 characters
allowed_target_audiencesArray of objects(Apartmenttargetaudience)
apartment_idstring or null<= 4 characters'^\d{4}$'
tenantobject or null(Tenant)read-only
bi_areanumber or null(float)
categorystring or null<= 64 characters
Enum"PX_16_5_ROK""PX_1_ROK""PX_15_5_ROK""PX_1_5_RO""PX_14_ROK""PX_4_ROK""PX_3_ROS""PX_4_ROKV""PX_2_ROK""PX_3_5_ROKV"
tempered_areanumber or null(float)
has_base_rent_vatbooleanread-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
addressobject or null(Address)
custom_idstring or null<= 128 characters
usable_areanumber or null(float)
]
Response
application/json
[
  {
    "landlord_custom_id": "string",
    "archived": true,
    "financial_handler": { … },
    "bi_tenants": [ … ],
    "tags": null,
    "custom_dimension_value": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "market_apartment": null,
    "future_contracting": 0,
    "organization": { … },
    "status": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "floors": [ … ],
    "terms": { … },
    "popular_name": "string",
    "allowed_target_audiences": [ … ],
    "apartment_id": "stri",
    "building": { … },
    "tenant": { … },
    "bi_area": 0.1,
    "category": "PX_16_5_ROK",
    "tempered_area": 0.1,
    "has_base_rent_vat": true,
    "customer_columns": null,
    "pending_monitor_approval_amount": null,
    "address": { … },
    "custom_id": "string",
    "usable_area": 0.1
  }
]

/objects/spaces/vacancies/apartment/refresh/

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
any
curl -i -X POST \
  https://dev.api.pigello.io/objects/spaces/vacancies/apartment/refresh/ \
  -H 'Content-Type: application/json' \
  -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 creation

Bodyapplication/json
any
Response
application/json
null

Apartmentvacancynotation

Operations

Outdoorsection

Operations

Componentmodel

Operations

Componenttype

Operations

Parkinglot

Operations

Realestate

Operations

Building

Operations

Region

Operations

Community

Operations

Outdoorarea

Operations

Structurerenovationnotation

Operations

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.