Skip to content

Markets (2.0.0)

The 'Markets' 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

Marketconfiguration

Operations

Apartmentrequirementprofile

Operations

Apartmentlisting

Operations

Marketapartmentmedia

Operations

Marketmedia

Operations

Marketapartment

Operations

Create 'Marketapartment'

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
spaceobject(Apartment)required

Additional Validation Information:

Must be unique

space.​idstring(uuid)
has_shared_laundry_roomboolean or null
patio_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
custom_idstring or null<= 128 characters
has_waste_disposal_roomboolean or null
default_requirement_profileobject or null(Apartmentrequirementprofile)
washing_machine_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
kitchen_typestring or null<= 255 characters
Enum"KITCHENETTE""KITCHEN""SHARED_KITCHEN""NO_KITCHEN""MINI_KITCHEN"
has_private_patioboolean or null
listing_descriptionstring or null
kitchen_fan_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_shared_patioboolean or null
has_elevatorboolean or null
dishwasher_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_security_doorboolean or null
default_market_configurationobject or null(Marketconfiguration)
has_gymboolean or null
is_investment_support_apartmentboolean or null
has_common_roomboolean or null
has_bike_roomboolean or null
garagestring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
organizationobject or null(Organization)
balconystring or null<= 255 characters
Enum"FRENCH""GLASS""NONE""TERRACE""REGULAR"
has_shared_saunaboolean or null
handicap_adaptedboolean or null
has_shared_toiletboolean or null
bathtub_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
shower_typestring or null<= 255 characters
Enum"PRESENT""SHARED""NONE""PREPARED"
balcony_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
tumbler_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
parking_spotstring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
curl -i -X POST \
  https://dev.api.pigello.io/markets/spaces/marketapartment/ \
  -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 '{
    "space": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "has_shared_laundry_room": true,
    "patio_orientation": "WEST",
    "custom_id": "string",
    "has_waste_disposal_room": true,
    "default_requirement_profile": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "washing_machine_status": "PRESENT",
    "kitchen_type": "KITCHENETTE",
    "has_private_patio": true,
    "listing_description": "string",
    "kitchen_fan_status": "PRESENT",
    "has_shared_patio": true,
    "has_elevator": true,
    "dishwasher_status": "PRESENT",
    "has_security_door": true,
    "default_market_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "has_gym": true,
    "is_investment_support_apartment": true,
    "has_common_room": true,
    "has_bike_room": true,
    "garage": "INCLUDED",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "balcony": "FRENCH",
    "has_shared_sauna": true,
    "handicap_adapted": true,
    "has_shared_toilet": true,
    "bathtub_status": "PRESENT",
    "shower_type": "PRESENT",
    "balcony_orientation": "WEST",
    "tumbler_status": "PRESENT",
    "parking_spot": "INCLUDED"
  }'

Responses

Successful creation

Bodyapplication/json
spaceobject(Apartment)required

Additional Validation Information:

Must be unique

space.​idstring(uuid)
has_shared_laundry_roomboolean or null
patio_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
custom_idstring or null<= 128 characters
has_waste_disposal_roomboolean or null
default_requirement_profileobject or null(Apartmentrequirementprofile)
washing_machine_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
kitchen_typestring or null<= 255 characters
Enum"KITCHENETTE""KITCHEN""SHARED_KITCHEN""NO_KITCHEN""MINI_KITCHEN"
has_private_patioboolean or null
listing_descriptionstring or null
kitchen_fan_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_shared_patioboolean or null
has_elevatorboolean or null
dishwasher_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_security_doorboolean or null
default_market_configurationobject or null(Marketconfiguration)
has_gymboolean or null
is_investment_support_apartmentboolean or null
has_common_roomboolean or null
has_bike_roomboolean or null
garagestring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
organizationobject or null(Organization)
balconystring or null<= 255 characters
Enum"FRENCH""GLASS""NONE""TERRACE""REGULAR"
has_shared_saunaboolean or null
handicap_adaptedboolean or null
has_shared_toiletboolean or null
bathtub_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
created_atstring(date-time)read-only
shower_typestring or null<= 255 characters
Enum"PRESENT""SHARED""NONE""PREPARED"
balcony_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
tumbler_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
parking_spotstring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
Response
application/json
{
  "space": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "has_shared_laundry_room": true,
  "patio_orientation": "WEST",
  "custom_id": "string",
  "has_waste_disposal_room": true,
  "default_requirement_profile": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "washing_machine_status": "PRESENT",
  "kitchen_type": "KITCHENETTE",
  "has_private_patio": true,
  "listing_description": "string",
  "kitchen_fan_status": "PRESENT",
  "has_shared_patio": true,
  "has_elevator": true,
  "dishwasher_status": "PRESENT",
  "has_security_door": true,
  "default_market_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "has_gym": true,
  "is_investment_support_apartment": true,
  "has_common_room": true,
  "has_bike_room": true,
  "garage": "INCLUDED",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "balcony": "FRENCH",
  "has_shared_sauna": true,
  "handicap_adapted": true,
  "has_shared_toilet": true,
  "bathtub_status": "PRESENT",
  "created_at": "2019-08-24T14:15:22Z",
  "shower_type": "PRESENT",
  "balcony_orientation": "WEST",
  "tumbler_status": "PRESENT",
  "parking_spot": "INCLUDED"
}

Bulk write 'Marketapartment'

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 [
spaceobject(Apartment)required

Additional Validation Information:

Must be unique

space.​idstring(uuid)
has_shared_laundry_roomboolean or null
patio_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
custom_idstring or null<= 128 characters
has_waste_disposal_roomboolean or null
default_requirement_profileobject or null(Apartmentrequirementprofile)
washing_machine_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
kitchen_typestring or null<= 255 characters
Enum"KITCHENETTE""KITCHEN""SHARED_KITCHEN""NO_KITCHEN""MINI_KITCHEN"
has_private_patioboolean or null
listing_descriptionstring or null
kitchen_fan_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_shared_patioboolean or null
has_elevatorboolean or null
dishwasher_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_security_doorboolean or null
default_market_configurationobject or null(Marketconfiguration)
has_gymboolean or null
is_investment_support_apartmentboolean or null
has_common_roomboolean or null
has_bike_roomboolean or null
garagestring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
organizationobject or null(Organization)
balconystring or null<= 255 characters
Enum"FRENCH""GLASS""NONE""TERRACE""REGULAR"
has_shared_saunaboolean or null
handicap_adaptedboolean or null
has_shared_toiletboolean or null
bathtub_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
shower_typestring or null<= 255 characters
Enum"PRESENT""SHARED""NONE""PREPARED"
balcony_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
tumbler_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
parking_spotstring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
]
curl -i -X POST \
  https://dev.api.pigello.io/markets/spaces/marketapartment/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 '[
    {
      "space": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "has_shared_laundry_room": true,
      "patio_orientation": "WEST",
      "custom_id": "string",
      "has_waste_disposal_room": true,
      "default_requirement_profile": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "washing_machine_status": "PRESENT",
      "kitchen_type": "KITCHENETTE",
      "has_private_patio": true,
      "listing_description": "string",
      "kitchen_fan_status": "PRESENT",
      "has_shared_patio": true,
      "has_elevator": true,
      "dishwasher_status": "PRESENT",
      "has_security_door": true,
      "default_market_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "has_gym": true,
      "is_investment_support_apartment": true,
      "has_common_room": true,
      "has_bike_room": true,
      "garage": "INCLUDED",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "balcony": "FRENCH",
      "has_shared_sauna": true,
      "handicap_adapted": true,
      "has_shared_toilet": true,
      "bathtub_status": "PRESENT",
      "shower_type": "PRESENT",
      "balcony_orientation": "WEST",
      "tumbler_status": "PRESENT",
      "parking_spot": "INCLUDED"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
spaceobject(Apartment)required

Additional Validation Information:

Must be unique

space.​idstring(uuid)
has_shared_laundry_roomboolean or null
patio_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
custom_idstring or null<= 128 characters
has_waste_disposal_roomboolean or null
default_requirement_profileobject or null(Apartmentrequirementprofile)
washing_machine_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
kitchen_typestring or null<= 255 characters
Enum"KITCHENETTE""KITCHEN""SHARED_KITCHEN""NO_KITCHEN""MINI_KITCHEN"
has_private_patioboolean or null
listing_descriptionstring or null
kitchen_fan_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_shared_patioboolean or null
has_elevatorboolean or null
dishwasher_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_security_doorboolean or null
default_market_configurationobject or null(Marketconfiguration)
has_gymboolean or null
is_investment_support_apartmentboolean or null
has_common_roomboolean or null
has_bike_roomboolean or null
garagestring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
organizationobject or null(Organization)
balconystring or null<= 255 characters
Enum"FRENCH""GLASS""NONE""TERRACE""REGULAR"
has_shared_saunaboolean or null
handicap_adaptedboolean or null
has_shared_toiletboolean or null
bathtub_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
created_atstring(date-time)read-only
shower_typestring or null<= 255 characters
Enum"PRESENT""SHARED""NONE""PREPARED"
balcony_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
tumbler_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
parking_spotstring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
]
Response
application/json
[
  {
    "space": { … },
    "has_shared_laundry_room": true,
    "patio_orientation": "WEST",
    "custom_id": "string",
    "has_waste_disposal_room": true,
    "default_requirement_profile": { … },
    "washing_machine_status": "PRESENT",
    "kitchen_type": "KITCHENETTE",
    "has_private_patio": true,
    "listing_description": "string",
    "kitchen_fan_status": "PRESENT",
    "has_shared_patio": true,
    "has_elevator": true,
    "dishwasher_status": "PRESENT",
    "has_security_door": true,
    "default_market_configuration": { … },
    "has_gym": true,
    "is_investment_support_apartment": true,
    "has_common_room": true,
    "has_bike_room": true,
    "garage": "INCLUDED",
    "organization": { … },
    "balcony": "FRENCH",
    "has_shared_sauna": true,
    "handicap_adapted": true,
    "has_shared_toilet": true,
    "bathtub_status": "PRESENT",
    "created_at": "2019-08-24T14:15:22Z",
    "shower_type": "PRESENT",
    "balcony_orientation": "WEST",
    "tumbler_status": "PRESENT",
    "parking_spot": "INCLUDED"
  }
]

List 'Marketapartment'

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
global_realestatesArray of objects
global_segmentsArray of objects
idany

Additional operators:

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

id!any
balconyany

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

balcony_orientationany

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

bathtub_statusany

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_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

default_market_configurationany

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

default_requirement_profileany

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

dishwasher_statusany

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

garageany

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

handicap_adaptedany

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

has_bike_roomany

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

has_common_roomany

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

has_elevatorany

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

has_gymany

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

has_private_patioany

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

has_security_doorany

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

has_shared_laundry_roomany

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

has_shared_patioany

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

has_shared_saunaany

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

has_shared_toiletany

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

has_waste_disposal_roomany

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

is_investment_support_apartmentany

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

kitchen_fan_statusany

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

kitchen_typeany

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

listing_descriptionany

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

parking_spotany

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

patio_orientationany

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

shower_typeany

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

spaceany

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

tumbler_statusany

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

washing_machine_statusany

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

curl -i -X GET \
  'https://dev.api.pigello.io/markets/spaces/marketapartment/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 [
spaceobject(Apartment)required

Additional Validation Information:

Must be unique

space.​idstring(uuid)
has_shared_laundry_roomboolean or null
patio_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
custom_idstring or null<= 128 characters
has_waste_disposal_roomboolean or null
default_requirement_profileobject or null(Apartmentrequirementprofile)
washing_machine_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
kitchen_typestring or null<= 255 characters
Enum"KITCHENETTE""KITCHEN""SHARED_KITCHEN""NO_KITCHEN""MINI_KITCHEN"
has_private_patioboolean or null
listing_descriptionstring or null
kitchen_fan_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_shared_patioboolean or null
has_elevatorboolean or null
dishwasher_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
has_security_doorboolean or null
default_market_configurationobject or null(Marketconfiguration)
has_gymboolean or null
is_investment_support_apartmentboolean or null
has_common_roomboolean or null
has_bike_roomboolean or null
garagestring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
organizationobject or null(Organization)
balconystring or null<= 255 characters
Enum"FRENCH""GLASS""NONE""TERRACE""REGULAR"
has_shared_saunaboolean or null
handicap_adaptedboolean or null
has_shared_toiletboolean or null
bathtub_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
created_atstring(date-time)read-only
shower_typestring or null<= 255 characters
Enum"PRESENT""SHARED""NONE""PREPARED"
balcony_orientationstring or null<= 255 characters
Enum"WEST""SOUTH""NORTHEAST""NORTH""NORTHWEST""SOUTHWEST""EAST""SOUTHEAST"
tumbler_statusstring or null<= 255 characters
Enum"PRESENT""NONE""PREPARED"
parking_spotstring or null<= 255 characters
Enum"INCLUDED""NONE""AVAILABLE"
]
Response
application/json
[
  {
    "space": { … },
    "has_shared_laundry_room": true,
    "patio_orientation": "WEST",
    "custom_id": "string",
    "has_waste_disposal_room": true,
    "default_requirement_profile": { … },
    "washing_machine_status": "PRESENT",
    "kitchen_type": "KITCHENETTE",
    "has_private_patio": true,
    "listing_description": "string",
    "kitchen_fan_status": "PRESENT",
    "has_shared_patio": true,
    "has_elevator": true,
    "dishwasher_status": "PRESENT",
    "has_security_door": true,
    "default_market_configuration": { … },
    "has_gym": true,
    "is_investment_support_apartment": true,
    "has_common_room": true,
    "has_bike_room": true,
    "garage": "INCLUDED",
    "organization": { … },
    "balcony": "FRENCH",
    "has_shared_sauna": true,
    "handicap_adapted": true,
    "has_shared_toilet": true,
    "bathtub_status": "PRESENT",
    "created_at": "2019-08-24T14:15:22Z",
    "shower_type": "PRESENT",
    "balcony_orientation": "WEST",
    "tumbler_status": "PRESENT",
    "parking_spot": "INCLUDED"
  }
]
© Pigello. All rights reserved.