Skip to content

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

_slimboolean
_statisticsboolean
global_realestatesArray of any
global_segmentsArray of any
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_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

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

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

GET
/markets/spaces/marketapartment/list/
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&global_realestates=&global_segments=&id=%7Bid%7D&id!=%7Bid!%7D&balcony=%7Bbalcony%7D&balcony_orientation=%7Bbalcony_orientation%7D&bathtub_status=%7Bbathtub_status%7D&created_at=%7Bcreated_at%7D&custom_id=%7Bcustom_id%7D&default_requirement_profile=%7Bdefault_requirement_profile%7D&dishwasher_status=%7Bdishwasher_status%7D&garage=%7Bgarage%7D&handicap_adapted=%7Bhandicap_adapted%7D&has_bike_room=%7Bhas_bike_room%7D&has_common_room=%7Bhas_common_room%7D&has_elevator=%7Bhas_elevator%7D&has_gym=%7Bhas_gym%7D&has_private_patio=%7Bhas_private_patio%7D&has_security_door=%7Bhas_security_door%7D&has_shared_laundry_room=%7Bhas_shared_laundry_room%7D&has_shared_patio=%7Bhas_shared_patio%7D&has_shared_sauna=%7Bhas_shared_sauna%7D&has_shared_toilet=%7Bhas_shared_toilet%7D&has_waste_disposal_room=%7Bhas_waste_disposal_room%7D&is_investment_support_apartment=%7Bis_investment_support_apartment%7D&kitchen_fan_status=%7Bkitchen_fan_status%7D&kitchen_type=%7Bkitchen_type%7D&listing_description=%7Blisting_description%7D&organization=%7Borganization%7D&parking_spot=%7Bparking_spot%7D&patio_orientation=%7Bpatio_orientation%7D&shower_type=%7Bshower_type%7D&space=%7Bspace%7D&terms=%7Bterms%7D&tumbler_status=%7Btumbler_status%7D&washing_machine_status=%7Bwashing_machine_status%7D' \
  -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/json
Array [
spaceobject(Apartment)required

Additional Validation Information:

Must be unique

organizationobject or null(Organization)
custom_idstring or null, <= 128 characters
created_atstring, (date-time)read-only
default_requirement_profileobject or null(ApartmentRequirementProfile)
termsobject or null(ApartmentTerms)
listing_descriptionstring or null
kitchen_typestring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • KITCHEN - Kitchen

  • KITCHENETTE - Kitchenette

  • MINI_KITCHEN - Mini Kitchen

  • SHARED_KITCHEN - Shared Kitchen

  • NO_KITCHEN - No Kitchen

Enum:"KITCHEN""KITCHENETTE""MINI_KITCHEN""SHARED_KITCHEN""NO_KITCHEN"
has_security_doorboolean or null
kitchen_fan_statusstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • PREPARED - Prepared

  • PRESENT - Present

Enum:"NONE""PREPARED""PRESENT"
washing_machine_statusstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • PREPARED - Prepared

  • PRESENT - Present

Enum:"NONE""PREPARED""PRESENT"
tumbler_statusstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • PREPARED - Prepared

  • PRESENT - Present

Enum:"NONE""PREPARED""PRESENT"
dishwasher_statusstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • PREPARED - Prepared

  • PRESENT - Present

Enum:"NONE""PREPARED""PRESENT"
bathtub_statusstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • PREPARED - Prepared

  • PRESENT - Present

Enum:"NONE""PREPARED""PRESENT"
shower_typestring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • PREPARED - Prepared

  • PRESENT - Present

  • SHARED - Shared

Enum:"NONE""PREPARED""PRESENT""SHARED"
handicap_adaptedboolean or null
has_private_patioboolean or null
patio_orientationstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NORTH - North

  • NORTHEAST - Northeast

  • EAST - East

  • SOUTHEAST - Southeast

  • SOUTH - South

  • SOUTHWEST - Southwest

  • WEST - West

  • NORTHWEST - Northwest

Enum:"NORTH""NORTHEAST""EAST""SOUTHEAST""SOUTH""SOUTHWEST""WEST""NORTHWEST"
balconystring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • REGULAR - Regular

  • FRENCH - French

  • GLASS - Glass

  • TERRACE - Terrace

Enum:"NONE""REGULAR""FRENCH""GLASS""TERRACE"
balcony_orientationstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NORTH - North

  • NORTHEAST - Northeast

  • EAST - East

  • SOUTHEAST - Southeast

  • SOUTH - South

  • SOUTHWEST - Southwest

  • WEST - West

  • NORTHWEST - Northwest

Enum:"NORTH""NORTHEAST""EAST""SOUTHEAST""SOUTH""SOUTHWEST""WEST""NORTHWEST"
parking_spotstring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • AVAILABLE - Available

  • INCLUDED - Included

Enum:"NONE""AVAILABLE""INCLUDED"
garagestring or null, <= 255 characters

Additional Validation Information:

Enum Descriptions:

  • NONE - None

  • AVAILABLE - Available

  • INCLUDED - Included

Enum:"NONE""AVAILABLE""INCLUDED"
has_shared_patioboolean or null
has_elevatorboolean or null
has_shared_laundry_roomboolean or null
has_shared_toiletboolean or null
has_shared_saunaboolean or null
has_bike_roomboolean or null
has_common_roomboolean or null
has_gymboolean or null
has_waste_disposal_roomboolean or null
is_investment_support_apartmentboolean or null
]
Response
[
  {
    "organization": { … },
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "space": { … },
    "default_requirement_profile": { … },
    "terms": { … },
    "listing_description": "string",
    "kitchen_type": "KITCHEN",
    "has_security_door": true,
    "kitchen_fan_status": "NONE",
    "washing_machine_status": "NONE",
    "tumbler_status": "NONE",
    "dishwasher_status": "NONE",
    "bathtub_status": "NONE",
    "shower_type": "NONE",
    "handicap_adapted": true,
    "has_private_patio": true,
    "patio_orientation": "NORTH",
    "balcony": "NONE",
    "balcony_orientation": "NORTH",
    "parking_spot": "NONE",
    "garage": "NONE",
    "has_shared_patio": true,
    "has_elevator": true,
    "has_shared_laundry_room": true,
    "has_shared_toilet": true,
    "has_shared_sauna": true,
    "has_bike_room": true,
    "has_common_room": true,
    "has_gym": true,
    "has_waste_disposal_room": true,
    "is_investment_support_apartment": true
  }
]
© Pigello. All rights reserved.