ApartmentListingSubscription

Operations

List 'ApartmentListingSubscription'

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 any

global_segmentsArray of any

matching_listingany

bathtub_presentany

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

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

floor_maxany

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

floor_minany

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

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

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

is_activeany

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

last_checked_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

max_rentany

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

max_roomsany

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

min_roomsany

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

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

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

tenant_applicantany

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

GET

/markets/listings/apartmentlistingsubscription/list/

curl -i -X GET \
  'https://dev.api.pigello.io/markets/listings/apartmentlistingsubscription/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=&matching_listing=%7Bmatching_listing%7D&bathtub_present=%7Bbathtub_present%7D&created_at=%7Bcreated_at%7D&custom_id=%7Bcustom_id%7D&floor_max=%7Bfloor_max%7D&floor_min=%7Bfloor_min%7D&handicap_adapted=%7Bhandicap_adapted%7D&has_elevator=%7Bhas_elevator%7D&has_private_patio=%7Bhas_private_patio%7D&id=%7Bid%7D&is_active=%7Bis_active%7D&last_checked_at=%7Blast_checked_at%7D&max_rent=%7Bmax_rent%7D&max_rooms=%7Bmax_rooms%7D&min_rooms=%7Bmin_rooms%7D&name=%7Bname%7D&organization=%7Borganization%7D&tenant_applicant=%7Btenant_applicant%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 [

idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenant_applicantobject(TenantApplicant)required

is_activebooleanrequired

last_checked_atstring, (date-time)read-onlyrequired

organizationobject or null(Organization)

custom_idstring or null, <= 128 characters

created_atstring, (date-time)read-only

namestring or null, <= 255 characters

regionsArray of strings, (uuid), unique

communitiesArray of strings, (uuid), unique

max_rentinteger or null, (int32), <= 2147483647

min_roomsstring or null, (decimal)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: max_rooms

Minimum value: 0

max_roomsstring or null, (decimal)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: min_rooms

Minimum value: 0

floor_mininteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: floor_max

floor_maxinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: floor_min

balconyArray of strings, unique

Additional Validation Information:

Enum Descriptions:

NONE - None
REGULAR - Regular
FRENCH - French
GLASS - Glass
TERRACE - Terrace

Items Enum:"NONE""REGULAR""FRENCH""GLASS""TERRACE"

has_private_patioboolean or null

handicap_adaptedboolean or null

has_elevatorboolean or null

parking_spotArray of strings, unique

Additional Validation Information:

Enum Descriptions:

NONE - None
AVAILABLE - Available
INCLUDED - Included

Items Enum:"NONE""AVAILABLE""INCLUDED"

garageArray of strings, unique

Additional Validation Information:

Enum Descriptions:

NONE - None
AVAILABLE - Available
INCLUDED - Included

Items Enum:"NONE""AVAILABLE""INCLUDED"

bathtub_presentboolean or null

]

Response

[
  {
    "organization": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "tenant_applicant": { … },
    "name": "string",
    "is_active": true,
    "last_checked_at": "2019-08-24T14:15:22Z",
    "regions": [ … ],
    "communities": [ … ],
    "max_rent": 2147483647,
    "min_rooms": "string",
    "max_rooms": "string",
    "floor_min": -2147483648,
    "floor_max": -2147483648,
    "balcony": "NONE",
    "has_private_patio": true,
    "handicap_adapted": true,
    "has_elevator": true,
    "parking_spot": "NONE",
    "garage": "NONE",
    "bathtub_present": true
  }
]