Skip to content
/
List 'Apartmenttargetaudi...

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

Create 'Apartmenttargetaudience'

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
namestring<= 255 charactersrequired
allow_creditorboolean or null
post_rent_net_income_factornumber or null(float)>= 1
organizationobject or null(Organization)
allow_benefit_incomeboolean or null
pre_rent_net_income_factornumber or null(float)>= 1
archivedboolean
allow_temporary_workboolean or null
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
custom_idstring or null<= 128 characters
allow_any_bankruptcyboolean or null
minimum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

allow_non_primary_residenceboolean or null
allow_part_time_workboolean or null
allow_any_dept_sanitationboolean or null
include_co_residents_incomeboolean
retiredboolean or null
maximum_number_of_co_residentsinteger or null(int32)<= 2147483647
studentsboolean or null
disabilitiesboolean or null
allow_trusteeboolean or null
maximum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

curl -i -X POST \
  https://dev.api.pigello.io/objects/spaces/targetaudiences/apartmenttargetaudience/ \
  -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 '{
    "allow_creditor": true,
    "name": "string",
    "post_rent_net_income_factor": 1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "allow_benefit_income": true,
    "pre_rent_net_income_factor": 1,
    "archived": true,
    "allow_temporary_work": true,
    "maximum_payment_remark_amount": 2147483647,
    "custom_id": "string",
    "allow_any_bankruptcy": true,
    "minimum_age": 12,
    "allow_non_primary_residence": true,
    "allow_part_time_work": true,
    "allow_any_dept_sanitation": true,
    "include_co_residents_income": true,
    "retired": true,
    "maximum_number_of_co_residents": 2147483647,
    "students": true,
    "disabilities": true,
    "allow_trustee": true,
    "maximum_age": 12
  }'

Responses

Successful creation

Bodyapplication/json
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

allow_creditorboolean or null
post_rent_net_income_factornumber or null(float)>= 1
organizationobject or null(Organization)
customer_columnsanyread-only
allow_benefit_incomeboolean or null
pre_rent_net_income_factornumber or null(float)>= 1
archivedboolean
allow_temporary_workboolean or null
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
allow_any_bankruptcyboolean or null
tagsanyread-only
minimum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

allow_non_primary_residenceboolean or null
allow_part_time_workboolean or null
allow_any_dept_sanitationboolean or null
include_co_residents_incomeboolean
retiredboolean or null
maximum_number_of_co_residentsinteger or null(int32)<= 2147483647
studentsboolean or null
disabilitiesboolean or null
allow_trusteeboolean or null
maximum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

Response
application/json
{
  "allow_creditor": true,
  "name": "string",
  "post_rent_net_income_factor": 1,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "allow_benefit_income": true,
  "pre_rent_net_income_factor": 1,
  "archived": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "allow_temporary_work": true,
  "maximum_payment_remark_amount": 2147483647,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "allow_any_bankruptcy": true,
  "tags": null,
  "minimum_age": 12,
  "allow_non_primary_residence": true,
  "allow_part_time_work": true,
  "allow_any_dept_sanitation": true,
  "include_co_residents_income": true,
  "retired": true,
  "maximum_number_of_co_residents": 2147483647,
  "students": true,
  "disabilities": true,
  "allow_trustee": true,
  "maximum_age": 12
}

List 'Apartmenttargetaudience'

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
tagsArray of objects
allow_any_bankruptcyany

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

allow_any_dept_sanitationany

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

allow_benefit_incomeany

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

allow_creditorany

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

allow_non_primary_residenceany

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

allow_part_time_workany

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

allow_temporary_workany

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

allow_trusteeany

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

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

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

disabilitiesany

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

include_co_residents_incomeany

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

maximum_ageany

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

maximum_number_of_co_residentsany

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

maximum_payment_remark_amountany

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

minimum_ageany

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

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

post_rent_net_income_factorany

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

pre_rent_net_income_factorany

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

retiredany

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

studentsany

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

curl -i -X GET \
  'https://dev.api.pigello.io/objects/spaces/targetaudiences/apartmenttargetaudience/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 [
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

allow_creditorboolean or null
post_rent_net_income_factornumber or null(float)>= 1
organizationobject or null(Organization)
customer_columnsanyread-only
allow_benefit_incomeboolean or null
pre_rent_net_income_factornumber or null(float)>= 1
archivedboolean
allow_temporary_workboolean or null
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
allow_any_bankruptcyboolean or null
tagsanyread-only
minimum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

allow_non_primary_residenceboolean or null
allow_part_time_workboolean or null
allow_any_dept_sanitationboolean or null
include_co_residents_incomeboolean
retiredboolean or null
maximum_number_of_co_residentsinteger or null(int32)<= 2147483647
studentsboolean or null
disabilitiesboolean or null
allow_trusteeboolean or null
maximum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

]
Response
application/json
[
  {
    "allow_creditor": true,
    "name": "string",
    "post_rent_net_income_factor": 1,
    "organization": { … },
    "customer_columns": null,
    "allow_benefit_income": true,
    "pre_rent_net_income_factor": 1,
    "archived": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "allow_temporary_work": true,
    "maximum_payment_remark_amount": 2147483647,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "allow_any_bankruptcy": true,
    "tags": null,
    "minimum_age": 12,
    "allow_non_primary_residence": true,
    "allow_part_time_work": true,
    "allow_any_dept_sanitation": true,
    "include_co_residents_income": true,
    "retired": true,
    "maximum_number_of_co_residents": 2147483647,
    "students": true,
    "disabilities": true,
    "allow_trustee": true,
    "maximum_age": 12
  }
]

Bulk write 'Apartmenttargetaudience'

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 [
namestring<= 255 charactersrequired
allow_creditorboolean or null
post_rent_net_income_factornumber or null(float)>= 1
organizationobject or null(Organization)
allow_benefit_incomeboolean or null
pre_rent_net_income_factornumber or null(float)>= 1
archivedboolean
allow_temporary_workboolean or null
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
custom_idstring or null<= 128 characters
allow_any_bankruptcyboolean or null
minimum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

allow_non_primary_residenceboolean or null
allow_part_time_workboolean or null
allow_any_dept_sanitationboolean or null
include_co_residents_incomeboolean
retiredboolean or null
maximum_number_of_co_residentsinteger or null(int32)<= 2147483647
studentsboolean or null
disabilitiesboolean or null
allow_trusteeboolean or null
maximum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

]
curl -i -X POST \
  https://dev.api.pigello.io/objects/spaces/targetaudiences/apartmenttargetaudience/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 '[
    {
      "allow_creditor": true,
      "name": "string",
      "post_rent_net_income_factor": 1,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "allow_benefit_income": true,
      "pre_rent_net_income_factor": 1,
      "archived": true,
      "allow_temporary_work": true,
      "maximum_payment_remark_amount": 2147483647,
      "custom_id": "string",
      "allow_any_bankruptcy": true,
      "minimum_age": 12,
      "allow_non_primary_residence": true,
      "allow_part_time_work": true,
      "allow_any_dept_sanitation": true,
      "include_co_residents_income": true,
      "retired": true,
      "maximum_number_of_co_residents": 2147483647,
      "students": true,
      "disabilities": true,
      "allow_trustee": true,
      "maximum_age": 12
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

allow_creditorboolean or null
post_rent_net_income_factornumber or null(float)>= 1
organizationobject or null(Organization)
customer_columnsanyread-only
allow_benefit_incomeboolean or null
pre_rent_net_income_factornumber or null(float)>= 1
archivedboolean
allow_temporary_workboolean or null
maximum_payment_remark_amountinteger or null(int32)<= 2147483647
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
allow_any_bankruptcyboolean or null
tagsanyread-only
minimum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

allow_non_primary_residenceboolean or null
allow_part_time_workboolean or null
allow_any_dept_sanitationboolean or null
include_co_residents_incomeboolean
retiredboolean or null
maximum_number_of_co_residentsinteger or null(int32)<= 2147483647
studentsboolean or null
disabilitiesboolean or null
allow_trusteeboolean or null
maximum_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

]
Response
application/json
[
  {
    "allow_creditor": true,
    "name": "string",
    "post_rent_net_income_factor": 1,
    "organization": { … },
    "customer_columns": null,
    "allow_benefit_income": true,
    "pre_rent_net_income_factor": 1,
    "archived": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "allow_temporary_work": true,
    "maximum_payment_remark_amount": 2147483647,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "allow_any_bankruptcy": true,
    "tags": null,
    "minimum_age": 12,
    "allow_non_primary_residence": true,
    "allow_part_time_work": true,
    "allow_any_dept_sanitation": true,
    "include_co_residents_income": true,
    "retired": true,
    "maximum_number_of_co_residents": 2147483647,
    "students": true,
    "disabilities": true,
    "allow_trustee": true,
    "maximum_age": 12
  }
]

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

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.