TenantApplicant

Operations

List 'TenantApplicant'

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

idany

Additional operators:

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

id!any

queuesArray of any

additional_notesany

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

annual_incomeany

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

business_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

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

current_housing_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

current_landlordany

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

current_landlord_phone_numberany

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

employer_emailany

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

employer_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

employer_phone_numberany

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

employer_websiteany

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

employment_role_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

employment_start_yearany

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_petsany

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

number_of_employeesany

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

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

revenue_last_annual_reportany

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

GET

/markets/applicants/tenantapplicant/list/

curl -i -X GET \
  'https://dev.api.pigello.io/markets/applicants/tenantapplicant/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&queues=&additional_notes=%7Badditional_notes%7D&annual_income=%7Bannual_income%7D&business_description=%7Bbusiness_description%7D&created_at=%7Bcreated_at%7D&current_housing_type=%7Bcurrent_housing_type%7D&current_landlord=%7Bcurrent_landlord%7D&current_landlord_phone_number=%7Bcurrent_landlord_phone_number%7D&custom_id=%7Bcustom_id%7D&employer_email=%7Bemployer_email%7D&employer_name=%7Bemployer_name%7D&employer_phone_number=%7Bemployer_phone_number%7D&employer_website=%7Bemployer_website%7D&employment_role_description=%7Bemployment_role_description%7D&employment_start_year=%7Bemployment_start_year%7D&has_pets=%7Bhas_pets%7D&number_of_employees=%7Bnumber_of_employees%7D&organization=%7Borganization%7D&revenue_last_annual_report=%7Brevenue_last_annual_report%7D&tenant=%7Btenant%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 [

tenantobject(Tenant)required

Additional Validation Information:

Must be unique

organizationobject or null(Organization)

custom_idstring or null, <= 128 characters

created_atstring, (date-time)read-only

income_sourcesArray of strings, unique

Additional Validation Information:

Enum Descriptions:

ACTIVITY_COMPENSATION - Activity Compensation
ACTIVITY_GRANT - Activity Grant
UNEMPLOYMENT_BENEFIT - Unemployment Benefit
PARENTAL_LEAVE - Parental Leave
SICK_LEAVE - Sick Leave
DEVELOPMENT_ALLOWANCE - Development Allowance
CHILD_PENSION - Child Pension
CARE_ALLOWANCE - Care Allowance
STUDENT_AID - Student Aid
HOUSING_ALLOWANCE - Housing Allowance
HOUSING_SUPPLEMENT - Housing Supplement
ESTABLISHMENT_SUPPLEMENT - Establishment Supplement
EXTRA_COST_ALLOWANCE - Extra Cost Allowance
LIVING_EXPENSE_SUPPLEMENT - Living Expense Supplement
CHILD_ALLOWANCE - Child Allowance
MAINTENANCE_ALLOWANCE - Maintenance Allowance
MAINTENANCE_SUPPORT - Maintenance Support
FIXED_TERM - Fixed Term
STUDENT_INCOME - Student Income
PERMANENT_EMPLOYMENT - Permanent Employment
PENSION - Pension

Items Enum:"ACTIVITY_COMPENSATION""ACTIVITY_GRANT""UNEMPLOYMENT_BENEFIT""PARENTAL_LEAVE""SICK_LEAVE""DEVELOPMENT_ALLOWANCE""CHILD_PENSION""CARE_ALLOWANCE""STUDENT_AID""HOUSING_ALLOWANCE"

annual_incomeinteger or null, (int32), <= 2147483647

employment_role_descriptionstring or null, <= 1024 characters

employment_start_yearinteger or null, (int32), <= 2147483647

employer_namestring or null, <= 1024 characters

employer_phone_numberstring or null, <= 1024 characters'^\+?1?\d{7,15}$'

employer_emailstring or null, (email), <= 254 characters

employer_websitestring or null, (url), <= 200 characters

current_landlordstring or null, <= 1024 characters

current_landlord_phone_numberstring or null, <= 1024 characters'^\+?1?\d{7,15}$'

current_housing_typestring or null, <= 1024 characters

Additional Validation Information:

Enum Descriptions:

BRF_APARTMENT - Brf Apartment
RENTABLE_APARTMENT - Rentable Apartment
OWNER_OCCUPIED_HOUSING - Owner Occupied Housing
LIVING_WITH_PARENTS - Living With Parents
LODGER - Lodger

Enum:"BRF_APARTMENT""RENTABLE_APARTMENT""OWNER_OCCUPIED_HOUSING""LIVING_WITH_PARENTS""LODGER"

has_petsboolean or null

number_of_employeesinteger or null, (int32), <= 2147483647

revenue_last_annual_reportinteger or null, (int32), <= 2147483647

additional_residentsanyread-only

business_descriptionstring or null, <= 1000 characters

additional_notesstring or null, <= 1000 characters

]

Response

[
  {
    "organization": { … },
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "tenant": { … },
    "income_sources": "ACTIVITY_COMPENSATION",
    "annual_income": 2147483647,
    "employment_role_description": "string",
    "employment_start_year": 2147483647,
    "employer_name": "string",
    "employer_phone_number": "string",
    "employer_email": "user@example.com",
    "employer_website": "string",
    "current_landlord": "string",
    "current_landlord_phone_number": "string",
    "current_housing_type": "BRF_APARTMENT",
    "has_pets": true,
    "number_of_employees": 2147483647,
    "revenue_last_annual_report": 2147483647,
    "additional_residents": null,
    "business_description": "string",
    "additional_notes": "string"
  }
]