Tenants (Facility Level)
Tenant information
Discussion
A tenant is a record about a person. Although most tenant records will be associated with either a current ledger or a previous ledger, tenant records can also be associated with leads. The existence of a tenant record does not necessarily indicate that the person is occupying a unit (or ever has).
A facility has the option to disable a tenant's ability to edit their mailing address. If this setting is turned on, an AccessDenied error will return in this case.
GET /v1/:facility_id/tenants
Shows all tenants
Examples
GET /v1/65c2a70c-777c-47ed-8bad-fcd5996e802f/tenants
200
{
"tenants": [
{
"id": "543a0085-841c-4925-8cbb-848cbd8e3e09",
"account_number": 1000000,
"first_name": "Al78",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"01f294ea-cfce-4bcb-a1c4-b858fbc0fa43"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_78",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:37.509-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "6934a267-8575-49de-adaf-a4acb16b2a99",
"primary": true,
"source": null,
"number": "+12762547277",
"formatted_number": "(276) 254-7277 x 8650",
"extension": "8650",
"label": "Fax",
"unformatted_number": "2762547277",
"sms_opt_in": false
},
{
"id": "eee00780-4295-42b2-8c8f-b0831be0f3ca",
"primary": false,
"source": null,
"number": "+19805300019",
"formatted_number": "(980) 530-0019 x 2676",
"extension": "2676",
"label": "Work",
"unformatted_number": "9805300019",
"sms_opt_in": false
},
{
"id": "35eab36e-6964-4d5d-bb76-deb6c0a62d5b",
"primary": false,
"source": null,
"number": "+12528502146",
"formatted_number": "(252) 850-2146 x 3477",
"extension": "3477",
"label": "Fax",
"unformatted_number": "2528502146",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "f87fa3b9-490e-4eee-9cdb-6ab1bf19280d",
"address1": "54591024 Parisian Ridges",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "54591024 Parisian Ridges, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "f87fa3b9-490e-4eee-9cdb-6ab1bf19280d",
"address1": "54591024 Parisian Ridges",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "54591024 Parisian Ridges, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "65c2a70c-777c-47ed-8bad-fcd5996e802f",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [
"d8a0d9d2-9bf8-421b-8db4-02422234bb31"
],
"support_case_ids": [],
"event_ids": [
"4130445f-79e5-4192-9987-a02bfb2d487c",
"eddf8cfe-e386-433d-ad55-b2b4ea0634a6"
],
"password_recovery_question_ids": [
"301d91f3-0c8c-4a57-900a-674dbecb04e4",
"c8976065-61bb-40ba-8b23-bdaa3dbd87eb"
]
},
{
"id": "0452da5a-c96d-4d37-baf3-e1f306ba77f3",
"account_number": 1000001,
"first_name": "Marcos79",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"025ffeb0-a14c-49de-beb9-22e35501d5fc"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_79",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:37.796-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "a91aedf8-0ace-4246-b927-61195933e167",
"primary": true,
"source": null,
"number": "+16233142491",
"formatted_number": "(623) 314-2491 x 6814",
"extension": "6814",
"label": "Home",
"unformatted_number": "6233142491",
"sms_opt_in": false
},
{
"id": "3855e91f-76d7-48b6-985c-a57d545d96a9",
"primary": false,
"source": null,
"number": "+16179018989",
"formatted_number": "(617) 901-8989 x 8696",
"extension": "8696",
"label": "Home",
"unformatted_number": "6179018989",
"sms_opt_in": false
},
{
"id": "8eebedae-60cb-494f-ae85-d7658898aceb",
"primary": false,
"source": null,
"number": "+17208307519",
"formatted_number": "(720) 830-7519",
"extension": null,
"label": "Work",
"unformatted_number": "7208307519",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "5a12374f-0e17-4a1f-a72e-2742077e1604",
"address1": "547825 Tremblay Estates",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "547825 Tremblay Estates, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "5a12374f-0e17-4a1f-a72e-2742077e1604",
"address1": "547825 Tremblay Estates",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "547825 Tremblay Estates, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "65c2a70c-777c-47ed-8bad-fcd5996e802f",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [
"07bc3547-ee30-414e-879b-1b5ff4061c43"
],
"support_case_ids": [],
"event_ids": [
"3c34102a-17f5-45ae-a67a-c53899e34d9f",
"8b1be8d5-ae3b-4f87-83c4-182aaa96f735"
],
"password_recovery_question_ids": [
"4941c7f0-a82f-40af-8752-e6c7b8adfc5c",
"4c8ae650-f9c3-428c-bf34-8155b456d81a"
]
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 2,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "65c2a70c-777c-47ed-8bad-fcd5996e802f",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/previous
Shows all previous (moved-out) tenants
Examples
GET /v1/b4a83f1f-b21b-41d1-afe5-cd6b41ee547b/tenants/previous
200
{
"tenants": [
{
"id": "3e7e6ce4-1b29-43c9-9f59-54e363c78d1b",
"account_number": 1000000,
"first_name": "Rubie82",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_82",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:39.813-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "6fca8869-117f-4a90-bc0b-417e6b7b0304",
"primary": true,
"source": null,
"number": "+14403107454",
"formatted_number": "(440) 310-7454 x 7748",
"extension": "7748",
"label": "Home",
"unformatted_number": "4403107454",
"sms_opt_in": false
},
{
"id": "dba4608a-669d-45c1-b865-6cbb41d1a4f6",
"primary": false,
"source": null,
"number": "+13105806958",
"formatted_number": "(310) 580-6958",
"extension": null,
"label": "Mobile",
"unformatted_number": "3105806958",
"sms_opt_in": false
},
{
"id": "6850753c-6148-4ea7-87be-bc6770c14e5c",
"primary": false,
"source": null,
"number": "+13609141046",
"formatted_number": "(360) 914-1046 x 8681",
"extension": "8681",
"label": "Other",
"unformatted_number": "3609141046",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "e957c6fa-f583-49ab-a361-d8f91cd3ff8e",
"address1": "563619 Zachary Squares",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "563619 Zachary Squares, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "e957c6fa-f583-49ab-a361-d8f91cd3ff8e",
"address1": "563619 Zachary Squares",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "563619 Zachary Squares, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "b4a83f1f-b21b-41d1-afe5-cd6b41ee547b",
"previous_ledger_ids": [
"d89c5384-e96d-49a8-b976-1ff87a5ab8de"
],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [
"039c4d35-dfa6-4d56-8a10-663be1f4e164"
],
"support_case_ids": [],
"event_ids": [
"057d120f-a926-43a2-9dde-a4c70d5e4dc6",
"2ea6afd0-0379-4fb2-a185-d5f9809b628d"
],
"password_recovery_question_ids": [
"f1df6c7a-b9bd-4638-b35d-6f5f5d7cab64",
"ef487f5f-1f01-4920-8f19-0062bed9d36c"
]
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "b4a83f1f-b21b-41d1-afe5-cd6b41ee547b",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/current
Shows all current tenants
Examples
GET /v1/d4f8b6b0-5c68-48d8-8899-1bfe36303822/tenants/current
200
{
"tenants": [
{
"id": "f5ff9b4e-fed3-468d-af55-a860c22dbc16",
"account_number": 1000000,
"first_name": "Lajuana80",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"174ec7cd-8251-4d25-a4ba-5ff59cf16ef9"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_80",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:38.673-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "2f1d791a-c328-4d45-9d34-018545e11228",
"primary": true,
"source": null,
"number": "+13042522960",
"formatted_number": "(304) 252-2960 x 9563",
"extension": "9563",
"label": "Fax",
"unformatted_number": "3042522960",
"sms_opt_in": false
},
{
"id": "6c827e03-44ae-4fc0-a62d-21f7d0f41783",
"primary": false,
"source": null,
"number": "+16126469846",
"formatted_number": "(612) 646-9846 x 1010",
"extension": "1010",
"label": "Other",
"unformatted_number": "6126469846",
"sms_opt_in": false
},
{
"id": "1949c9f5-52a3-4ee7-aa04-3cff4894a497",
"primary": false,
"source": null,
"number": "+18644128349",
"formatted_number": "(864) 412-8349",
"extension": null,
"label": "Mobile",
"unformatted_number": "8644128349",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "b649455d-2381-4346-8e63-8d1be359926e",
"address1": "55490402 Marceline Fork",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "55490402 Marceline Fork, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "b649455d-2381-4346-8e63-8d1be359926e",
"address1": "55490402 Marceline Fork",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "55490402 Marceline Fork, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "d4f8b6b0-5c68-48d8-8899-1bfe36303822",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [
"f7876b7e-1ad7-45a5-b94e-57f8f19b6dc2"
],
"support_case_ids": [],
"event_ids": [
"6b4b0c79-e10f-45be-add0-5d350848b6e2",
"11173098-a558-4646-8f88-defaaec6b859"
],
"password_recovery_question_ids": [
"3d18f4fb-4828-4b63-987f-df05eb9edd15",
"6c0d5a38-f590-4c41-8a43-574170a4fb19"
]
},
{
"id": "daba0b77-1004-47a7-8b19-f3ac046df22a",
"account_number": 1000001,
"first_name": "Joel81",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"5f10f887-0cd4-46bb-9a66-99f9bcb3a3cc"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_81",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:38.935-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "37b659a6-81ba-480d-a020-fdef9ee5a70c",
"primary": true,
"source": null,
"number": "+17149548712",
"formatted_number": "(714) 954-8712 x 2998",
"extension": "2998",
"label": "Other",
"unformatted_number": "7149548712",
"sms_opt_in": false
},
{
"id": "bc1ba7e1-168b-464f-b3c1-e0f55cf01754",
"primary": false,
"source": null,
"number": "+13108187784",
"formatted_number": "(310) 818-7784 x 6053",
"extension": "6053",
"label": "Pager",
"unformatted_number": "3108187784",
"sms_opt_in": false
},
{
"id": "d955c53f-c4f0-4425-bc3c-b4757d7affd1",
"primary": false,
"source": null,
"number": "+19207203936",
"formatted_number": "(920) 720-3936",
"extension": null,
"label": "Mobile",
"unformatted_number": "9207203936",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "c0865324-7114-4e2c-8caa-93356dbc281a",
"address1": "55656085 Dibbert Isle",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "55656085 Dibbert Isle, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "c0865324-7114-4e2c-8caa-93356dbc281a",
"address1": "55656085 Dibbert Isle",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "55656085 Dibbert Isle, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "d4f8b6b0-5c68-48d8-8899-1bfe36303822",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [
"1188bd52-e5e4-40fb-b848-2f4a6c6c03e1"
],
"support_case_ids": [],
"event_ids": [
"4068c31f-6504-4801-afa1-892c02480830",
"3e30f7ed-8a80-4969-9754-61a2e5423a5f"
],
"password_recovery_question_ids": [
"14e30868-fb6a-473a-86af-833221fb42fa",
"60c6659c-ad29-4dff-ad1a-cf23446ac580"
]
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 2,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "d4f8b6b0-5c68-48d8-8899-1bfe36303822",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/:id
Show a particular tenant
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/ff6ce16b-381f-442f-a49a-01cdb99ec65e/tenants/c868b194-836f-4884-bda9-d8eed5329eaa
200
{
"tenant": {
"id": "c868b194-836f-4884-bda9-d8eed5329eaa",
"account_number": 1000000,
"first_name": "Harold76",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"29e0ac71-4f68-419c-a732-5e3f740f3812"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_76",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:36.405-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "31e1c516-1870-42d2-93f3-f9909a140a1d",
"primary": true,
"source": null,
"number": "+15207041751",
"formatted_number": "(520) 704-1751 x 6844",
"extension": "6844",
"label": "Fax",
"unformatted_number": "5207041751",
"sms_opt_in": false
},
{
"id": "405e6655-dd1f-40bc-a1c5-ed60ba6eab3a",
"primary": false,
"source": null,
"number": "+14153371956",
"formatted_number": "(415) 337-1956",
"extension": null,
"label": "Mobile",
"unformatted_number": "4153371956",
"sms_opt_in": false
},
{
"id": "c4a41a43-7c7b-46db-b5db-c9481fbb2bda",
"primary": false,
"source": null,
"number": "+14358179755",
"formatted_number": "(435) 817-9755",
"extension": null,
"label": "Pager",
"unformatted_number": "4358179755",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "8020e5fc-cbdc-4a63-917c-10cf42b995bb",
"address1": "53622282 Marcella Fields",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "53622282 Marcella Fields, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "8020e5fc-cbdc-4a63-917c-10cf42b995bb",
"address1": "53622282 Marcella Fields",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "53622282 Marcella Fields, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "ff6ce16b-381f-442f-a49a-01cdb99ec65e",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [
"772e29cd-6841-4eef-8391-94cfee12a929"
],
"support_case_ids": [],
"event_ids": [
"58a945a7-e0c3-4b1c-b505-a7e156e6b1f0",
"5287bb34-45c8-4f86-bdb6-197d7ff9c240"
],
"password_recovery_question_ids": [
"eb4551b8-20ce-4feb-ba41-35177c349956",
"b3e4f276-700d-4f71-982a-cebebc922ab2"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "ff6ce16b-381f-442f-a49a-01cdb99ec65e",
"id": "c868b194-836f-4884-bda9-d8eed5329eaa",
"tenant": {}
}
}
}
POST /v1/:facility_id/tenants/username_lookup
Lookup tenant based on username
Params
| Param name | Description |
|---|---|
|
tenant
optional |
Validations:
|
|
tenant[username]
required |
Validations:
|
Examples
POST /v1/b525b1d9-722a-48be-9518-f8b6bb1f9748/tenants/username_lookup
{
"username": "[email protected]",
"tenant": {
"username": "[email protected]"
}
}
200
{
"tenant": {
"id": "6ab104b1-6011-40ca-b60f-ba080cd7d18a",
"account_number": 1000002,
"first_name": "Example tenant",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "[email protected]",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:46.978-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "4762a6a6-6462-42c4-9b67-2c6026d9cdb2",
"address1": "615651 Velvet Falls",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "615651 Velvet Falls, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "4762a6a6-6462-42c4-9b67-2c6026d9cdb2",
"address1": "615651 Velvet Falls",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "615651 Velvet Falls, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "b525b1d9-722a-48be-9518-f8b6bb1f9748",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"14f85549-1125-4498-a433-1553a894f2ff",
"6cc688dc-290d-4e22-9621-afefb0f868f8"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"username": "[email protected]",
"facility_id": "b525b1d9-722a-48be-9518-f8b6bb1f9748",
"tenant": {
"username": "[email protected]"
}
}
}
}
POST /v1/:facility_id/tenants/forgot_username
Recover username based on account number
Params
| Param name | Description |
|---|---|
|
tenant
optional |
Validations:
|
|
tenant[account_number]
required |
Validations:
|
Examples
POST /v1/bfb183c9-6fec-44ba-adcf-39ab556e397f/tenants/forgot_username
{
"account_number": 1000002,
"tenant": {
"account_number": 1000002
}
}
200
{
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"account_number": "[FILTERED]",
"facility_id": "bfb183c9-6fec-44ba-adcf-39ab556e397f",
"tenant": {
"account_number": "[FILTERED]"
}
}
}
}
GET /v1/:facility_id/tenants/search
Search Tenants by phone number or account code.
Params
| Param name | Description |
|---|---|
|
phone_number
optional |
Phone number of the tenant. Either phonenumber or accountnumber is required, but not both. Validations:
|
|
account_number
optional |
Account number of the tenant. Either phonenumber or accountnumber is required, but not both. Validations:
|
Examples
GET /v1/bee88580-ae7f-40ad-8871-8ff19c6a25c8/tenants/search
200
{
"tenants": [
{
"id": "34720982-24e4-43eb-b71d-e64b4a718ac0",
"account_number": 123456,
"first_name": "Example tenant",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "[email protected]",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:45.589-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "454aab10-0078-4a6d-bdf7-5fb156b6f479",
"address1": "60591934 Cheree Forge",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "60591934 Cheree Forge, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "454aab10-0078-4a6d-bdf7-5fb156b6f479",
"address1": "60591934 Cheree Forge",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "60591934 Cheree Forge, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "bee88580-ae7f-40ad-8871-8ff19c6a25c8",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"c0698802-8cc1-4a2e-99c0-1373359d132f",
"24b8de8d-dd0e-471c-8589-0cc9dfe55e54"
]
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"account_number": "[FILTERED]",
"facility_id": "bee88580-ae7f-40ad-8871-8ff19c6a25c8",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/:tenant_id/eligibility
Show a tenant's eligibility to move in or perform other actions in storEDGE
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/701f13f5-4d9d-4606-9640-2072fd889a45/tenants/89c83095-cfe8-4ac1-972e-cebe7f75a0a4/eligibility
200
{
"eligibility": {
"eligible_for_move_in": true
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "701f13f5-4d9d-4606-9640-2072fd889a45",
"tenant_id": "89c83095-cfe8-4ac1-972e-cebe7f75a0a4",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/:tenant_id/notes
Show a tenants notes
Examples
GET /v1/36789e15-d09e-4d0a-9900-def7f331ec9a/tenants/25ab6b1e-22c5-4a51-b9a6-34d9b977bc67/notes
200
{
"notes": [
{
"id": "492a2d90-e7e1-485c-a6fa-2626a290404b",
"note": "test",
"created_at": "2023-09-15T04:37:43.060-10:00"
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "36789e15-d09e-4d0a-9900-def7f331ec9a",
"tenant_id": "25ab6b1e-22c5-4a51-b9a6-34d9b977bc67",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/:tenant_id/delinquency
Show a tenant's delinquency status
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/651e440e-62de-43d9-b2d9-0041268cb8ee/tenants/a1b6f449-8e90-4bbe-8c59-ef4a7e28e62d/delinquency
200
{
"delinquency": {
"gate_lockout_complete": false,
"overlock_complete": false,
"cut_lock_complete": false,
"lien_complete": false,
"auction_complete": false
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "651e440e-62de-43d9-b2d9-0041268cb8ee",
"tenant_id": "a1b6f449-8e90-4bbe-8c59-ef4a7e28e62d",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/:tenant_id/preferences
Show a tenants preferences
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
GET /v1/0d417e2f-13eb-4166-b8f9-7b54290b7a72/tenants/fd48fa68-8d92-4d3d-981b-1cad06fdad78/preferences
200
{
"tenant_settings": {
"id": "d2f35b26-5f72-4b52-b113-d04a0e329f78",
"tenants_preferences": {
"email_invoices": true,
"delinquency_exempt": false
},
"default_settings": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": {
"value": null,
"type": "Boolean"
},
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false
}
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "0d417e2f-13eb-4166-b8f9-7b54290b7a72",
"tenant_id": "fd48fa68-8d92-4d3d-981b-1cad06fdad78",
"tenant": {}
}
}
}
PUT /v1/:facility_id/tenants/:tenant_id/preferences
Update a tenants preferences
Examples
PUT /v1/5dab5715-852a-48dc-aa0f-1a988ecc1d85/tenants/c1f37013-4573-499b-b824-3cb4319432b9/preferences
{
"tenant_settings": {
"delinquency_exempt": true
},
"tenant": {}
}
200
{
"tenant_settings": {
"id": "a4fb3db8-5179-468c-9b4c-26810a9fc659",
"tenants_preferences": {
"email_invoices": true,
"delinquency_exempt": true
},
"default_settings": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": {
"value": null,
"type": "Boolean"
},
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false
}
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"tenant_settings": {
"delinquency_exempt": true
},
"facility_id": "5dab5715-852a-48dc-aa0f-1a988ecc1d85",
"tenant_id": "c1f37013-4573-499b-b824-3cb4319432b9",
"tenant": {}
}
}
}
GET /v1/:facility_id/tenants/:tenant_id/ledgers
Show a tenants current ledgers
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
PATCH /v1/:facility_id/tenants/:id
Update a tenant
PUT /v1/:facility_id/tenants/:id
Update a tenant
Params
| Param name | Description |
|---|---|
|
tenant
optional |
Validations:
|
|
tenant[first_name]
optional |
Validations:
|
|
tenant[account_number]
optional |
Validations:
|
|
tenant[middle_initial]
optional |
Validations:
|
|
tenant[last_name]
optional |
Validations:
|
|
tenant[drivers_license_number]
optional |
Validations:
|
|
tenant[drivers_license_state]
optional |
Validations:
|
|
tenant[vehicle_license_plate_number]
optional |
Validations:
|
|
tenant[vehicle_license_state]
optional |
Validations:
|
|
tenant[vehicle_description]
optional |
Validations:
|
|
tenant[email]
optional |
Validations:
|
|
tenant[username]
optional |
Validations:
|
|
tenant[password]
optional |
Validations:
|
|
tenant[tax_exempt]
optional |
Is the tenant tax exempt? Validations:
|
|
tenant[is_military]
optional |
Is the tenant military? Validations:
|
|
tenant[is_business]
optional |
Is the tenant a business? Validations:
|
|
tenant[business_name]
optional |
Validations:
|
|
tenant[title]
optional |
Validations:
|
|
tenant[decline_alternate_contact]
optional |
Whether or not the tenant declined to provide alternate contact information Validations:
|
|
tenant[military_information]
optional |
A collection of military information (if is_military is true). Validations:
|
|
tenant[military_information][retired_military]
optional |
Is the tenant retired military? Validations:
|
|
tenant[military_information][no_agent_given]
optional |
Is agent information provided? Validations:
|
|
tenant[military_information][date_entered_service]
optional |
Date entered service, Format: YYYY-MM-DD Validations:
|
|
tenant[military_information][military_id]
optional |
Validations:
|
|
tenant[military_information][end_of_active_service_date]
optional |
End date of active service, Format: YYYY-MM-DD Validations:
|
|
tenant[military_information][place_of_birth]
optional |
Validations:
|
|
tenant[military_information][last_4_of_ssn]
optional |
Must be a 4 digit number Validations:
|
|
tenant[military_information][military_email_address]
optional |
Must be a valid email address Validations:
|
|
tenant[military_information][military_rank]
optional |
Validations:
|
|
tenant[military_information][current_duty_location]
optional |
Validations:
|
|
tenant[military_information][branch_of_service]
optional |
Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other Validations:
|
|
tenant[military_information][military_unit]
optional |
Validations:
|
|
tenant[military_information][squadron]
optional |
Validations:
|
|
tenant[military_information][division]
optional |
Validations:
|
|
tenant[military_information][type_of_service]
optional |
Must be Active Component, Reserve Component, or National Guard Validations:
|
|
tenant[military_information][agent_first_name]
optional |
Validations:
|
|
tenant[military_information][agent_last_name]
optional |
Validations:
|
|
tenant[military_information][agent_email_address]
optional |
Must be a valid email address Validations:
|
|
tenant[military_information][agent_phone_number]
optional |
Must be a valid phone number Validations:
|
|
tenant[military_information][agent_address]
optional |
Validations:
|
|
tenant[military_information][agent_city]
optional |
Validations:
|
|
tenant[military_information][agent_state]
optional |
Must be a valid state abbreviation Validations:
|
|
tenant[military_information][agent_postal_code]
optional |
Must be a valid US postal code Validations:
|
|
tenant[military_information][officer_first_name]
optional |
Validations:
|
|
tenant[military_information][officer_last_name]
optional |
Validations:
|
|
tenant[military_information][officer_phone_number]
optional |
Must be a valid phone number Validations:
|
|
tenant[password_recovery_questions_attributes]
optional |
Password recovery questions Validations:
|
|
tenant[password_recovery_questions_attributes][question]
required |
Validations:
|
|
tenant[password_recovery_questions_attributes][answer]
required |
Validations:
|
|
tenant[phone_numbers_attributes]
required |
A collection of phone numbers. Validations:
|
|
tenant[phone_numbers_attributes][number]
optional |
Phone number Validations:
|
|
tenant[phone_numbers_attributes][extension]
required |
Phone number extension Validations:
|
|
tenant[phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
tenant[phone_numbers_attributes][primary]
optional |
Flag that indicates if this is the primary phone number of the tenant Validations:
|
|
tenant[phone_numbers_attributes][sms_opt_in]
optional |
Opt the tenant in to SMS (if applicable). Requires a "Mobile" label for SMS to work correctly. Validations:
|
|
tenant[mailing_address_attributes]
required |
A collection of addresses. Validations:
|
|
tenant[mailing_address_attributes][address1]
required |
Validations:
|
|
tenant[mailing_address_attributes][address2]
optional |
Validations:
|
|
tenant[mailing_address_attributes][city]
required |
Validations:
|
|
tenant[mailing_address_attributes][state]
required |
Validations:
|
|
tenant[mailing_address_attributes][postal]
required |
Validations:
|
|
tenant[contacts_attributes]
optional |
A collection of contacts. Validations:
|
|
tenant[contacts_attributes][id]
optional |
Contact id required to update a contact. Validations:
|
|
tenant[contacts_attributes][first_name]
optional |
Validations:
|
|
tenant[contacts_attributes][middle_initial]
optional |
Validations:
|
|
tenant[contacts_attributes][last_name]
optional |
Validations:
|
|
tenant[contacts_attributes][email]
optional |
Validations:
|
|
tenant[contacts_attributes][description]
required |
Contact description Validations:
|
|
tenant[contacts_attributes][primary]
optional |
Flag that indicates if this is the primary contact of the tenant Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes]
optional |
A collection of phone numbers. Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][number]
optional |
Phone number Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][extension]
optional |
Phone number extension Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][primary]
optional |
Flag that specifies if this is the primary phone number of the contact Validations:
|
|
tenant[contacts_attributes][address_attributes]
optional |
A collection of addresses. Validations:
|
|
tenant[contacts_attributes][address_attributes][address1]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][address2]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][city]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][state]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][postal]
optional |
Validations:
|
Examples
PUT /v1/7864e018-d91f-4487-91fd-370bfa73477d/tenants/b67ffe7f-cc9f-4b40-ae6b-bc8f61acf2ad
{
"tenant": {
"first_name": "Kelvin",
"last_name": "Benjamin",
"phone_numbers_attributes": [
{
"number": "5656663476",
"label": "Mobile",
"sms_opt_in": true
}
],
"mailing_address_attributes": {
"address1": "Ikea St",
"city": "Ikealand",
"state": "KS"
}
}
}
200
{
"tenant": {
"id": "b67ffe7f-cc9f-4b40-ae6b-bc8f61acf2ad",
"account_number": 1000000,
"first_name": "Kelvin",
"last_name": "Benjamin",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"76e6b8f4-6c07-433f-be54-02763b2f3832"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_74",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:37:35.003-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "d48e417d-21e9-4588-9348-34e11660e0c8",
"primary": true,
"source": null,
"number": "+13202130066",
"formatted_number": "(320) 213-0066 x 2433",
"extension": "2433",
"label": "Pager",
"unformatted_number": "3202130066",
"sms_opt_in": false
},
{
"id": "5b72e42f-8588-42e3-ad0b-643c8bbb0a56",
"primary": false,
"source": null,
"number": "+13602676190",
"formatted_number": "(360) 267-6190 x 0409",
"extension": "0409",
"label": "Mobile",
"unformatted_number": "3602676190",
"sms_opt_in": false
},
{
"id": "cc69fd2c-a7b8-451a-be90-7d0a7805a111",
"primary": false,
"source": null,
"number": "+18604755597",
"formatted_number": "(860) 475-5597",
"extension": null,
"label": "Pager",
"unformatted_number": "8604755597",
"sms_opt_in": false
},
{
"id": "388d0cd3-0166-4a41-b725-0010571fecda",
"primary": false,
"source": null,
"number": "+15656663476",
"formatted_number": "(565) 666-3476",
"extension": null,
"label": "Mobile",
"unformatted_number": "5656663476",
"sms_opt_in": true
}
],
"mailing_address": {
"id": "5197cc1a-bded-492d-858e-d62cf09b198d",
"address1": "Ikea St",
"address2": null,
"city": "Ikealand",
"state": "KS",
"postal": "89980",
"country": "US",
"full_address": "Ikea St, Ikealand, KS 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "5197cc1a-bded-492d-858e-d62cf09b198d",
"address1": "Ikea St",
"address2": null,
"city": "Ikealand",
"state": "KS",
"postal": "89980",
"country": "US",
"full_address": "Ikea St, Ikealand, KS 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
},
{
"id": "5197cc1a-bded-492d-858e-d62cf09b198d",
"address1": "Ikea St",
"address2": null,
"city": "Ikealand",
"state": "KS",
"postal": "89980",
"country": "US",
"full_address": "Ikea St, Ikealand, KS 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "7864e018-d91f-4487-91fd-370bfa73477d",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [
"cbbb886b-3099-4075-abaa-d3cb7a88fd0d"
],
"support_case_ids": [],
"event_ids": [
"4e1c5f33-83ab-4853-983f-6f445d91b4a3",
"9e163046-2137-4e5e-b7a0-1df8cea29c2a"
],
"password_recovery_question_ids": [
"e3d55c85-75a7-4aee-8e64-de24f7cf083d",
"a2b8a7d3-37a0-4a39-a946-645e44295433"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"tenant": {
"first_name": "Kelvin",
"last_name": "Benjamin",
"phone_numbers_attributes": [
{
"number": "5656663476",
"label": "Mobile",
"sms_opt_in": true
}
],
"mailing_address_attributes": {
"address1": "Ikea St",
"city": "Ikealand",
"state": "KS"
}
},
"facility_id": "7864e018-d91f-4487-91fd-370bfa73477d",
"id": "b67ffe7f-cc9f-4b40-ae6b-bc8f61acf2ad"
}
}
}
POST /v1/:facility_id/tenants/sign_in
Sign a tenant in
Params
| Param name | Description |
|---|---|
|
tenant
optional |
Validations:
|
|
tenant[login]
required |
Can be either an email or username. Validations:
|
|
tenant[password]
required |
Validations:
|
|
tenant[facility_uuid]
optional |
Validations:
|
Examples
POST /v1/022b1423-ffc9-47b2-99b7-1cb1a493595c/tenants/sign_in
{
"tenant": {
"login": "[email protected]",
"password": "super_secret_password"
}
}
200
{
"tenant": {
"id": "10bb10a1-5576-4490-83cf-fefbb7492e9a",
"account_number": 1000002,
"first_name": "Clarice68",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": "2023-09-15T04:37:32.042-10:00",
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "[email protected]",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": true,
"created_at": "2023-09-15T04:37:31.972-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "d4bc0555-bb2b-4669-a633-f624af26d7f5",
"address1": "50489734 Nia Vista",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "50489734 Nia Vista, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "d4bc0555-bb2b-4669-a633-f624af26d7f5",
"address1": "50489734 Nia Vista",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "50489734 Nia Vista, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "022b1423-ffc9-47b2-99b7-1cb1a493595c",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"bca87e9a-6ee0-41d2-bb44-6c21322a01aa",
"31df665d-fc78-4153-8c51-ae439a028b71"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"tenant": {
"login": "[email protected]",
"password": "[FILTERED]"
},
"facility_id": "022b1423-ffc9-47b2-99b7-1cb1a493595c"
}
}
}
POST /v1/:facility_id/tenants/:tenant_id/sign_up
Sign up for a tenant portal account
Params
| Param name | Description |
|---|---|
|
tenant
optional |
Validations:
|
|
tenant[first_name]
optional |
Validations:
|
|
tenant[account_number]
optional |
Validations:
|
|
tenant[middle_initial]
optional |
Validations:
|
|
tenant[last_name]
optional |
Validations:
|
|
tenant[drivers_license_number]
optional |
Validations:
|
|
tenant[drivers_license_state]
optional |
Validations:
|
|
tenant[vehicle_license_plate_number]
optional |
Validations:
|
|
tenant[vehicle_license_state]
optional |
Validations:
|
|
tenant[vehicle_description]
optional |
Validations:
|
|
tenant[email]
optional |
Validations:
|
|
tenant[username]
optional |
Validations:
|
|
tenant[password]
optional |
Validations:
|
|
tenant[tax_exempt]
optional |
Is the tenant tax exempt? Validations:
|
|
tenant[is_military]
optional |
Is the tenant military? Validations:
|
|
tenant[is_business]
optional |
Is the tenant a business? Validations:
|
|
tenant[business_name]
optional |
Validations:
|
|
tenant[title]
optional |
Validations:
|
|
tenant[decline_alternate_contact]
optional |
Whether or not the tenant declined to provide alternate contact information Validations:
|
|
tenant[military_information]
optional |
A collection of military information (if is_military is true). Validations:
|
|
tenant[military_information][retired_military]
optional |
Is the tenant retired military? Validations:
|
|
tenant[military_information][no_agent_given]
optional |
Is agent information provided? Validations:
|
|
tenant[military_information][date_entered_service]
optional |
Date entered service, Format: YYYY-MM-DD Validations:
|
|
tenant[military_information][military_id]
optional |
Validations:
|
|
tenant[military_information][end_of_active_service_date]
optional |
End date of active service, Format: YYYY-MM-DD Validations:
|
|
tenant[military_information][place_of_birth]
optional |
Validations:
|
|
tenant[military_information][last_4_of_ssn]
optional |
Must be a 4 digit number Validations:
|
|
tenant[military_information][military_email_address]
optional |
Must be a valid email address Validations:
|
|
tenant[military_information][military_rank]
optional |
Validations:
|
|
tenant[military_information][current_duty_location]
optional |
Validations:
|
|
tenant[military_information][branch_of_service]
optional |
Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other Validations:
|
|
tenant[military_information][military_unit]
optional |
Validations:
|
|
tenant[military_information][squadron]
optional |
Validations:
|
|
tenant[military_information][division]
optional |
Validations:
|
|
tenant[military_information][type_of_service]
optional |
Must be Active Component, Reserve Component, or National Guard Validations:
|
|
tenant[military_information][agent_first_name]
optional |
Validations:
|
|
tenant[military_information][agent_last_name]
optional |
Validations:
|
|
tenant[military_information][agent_email_address]
optional |
Must be a valid email address Validations:
|
|
tenant[military_information][agent_phone_number]
optional |
Must be a valid phone number Validations:
|
|
tenant[military_information][agent_address]
optional |
Validations:
|
|
tenant[military_information][agent_city]
optional |
Validations:
|
|
tenant[military_information][agent_state]
optional |
Must be a valid state abbreviation Validations:
|
|
tenant[military_information][agent_postal_code]
optional |
Must be a valid US postal code Validations:
|
|
tenant[military_information][officer_first_name]
optional |
Validations:
|
|
tenant[military_information][officer_last_name]
optional |
Validations:
|
|
tenant[military_information][officer_phone_number]
optional |
Must be a valid phone number Validations:
|
|
tenant[password_recovery_questions_attributes]
optional |
Password recovery questions Validations:
|
|
tenant[password_recovery_questions_attributes][question]
required |
Validations:
|
|
tenant[password_recovery_questions_attributes][answer]
required |
Validations:
|
|
tenant[phone_numbers_attributes]
required |
A collection of phone numbers. Validations:
|
|
tenant[phone_numbers_attributes][number]
optional |
Phone number Validations:
|
|
tenant[phone_numbers_attributes][extension]
required |
Phone number extension Validations:
|
|
tenant[phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
tenant[phone_numbers_attributes][primary]
optional |
Flag that indicates if this is the primary phone number of the tenant Validations:
|
|
tenant[phone_numbers_attributes][sms_opt_in]
optional |
Opt the tenant in to SMS (if applicable). Requires a "Mobile" label for SMS to work correctly. Validations:
|
|
tenant[mailing_address_attributes]
required |
A collection of addresses. Validations:
|
|
tenant[mailing_address_attributes][address1]
required |
Validations:
|
|
tenant[mailing_address_attributes][address2]
optional |
Validations:
|
|
tenant[mailing_address_attributes][city]
required |
Validations:
|
|
tenant[mailing_address_attributes][state]
required |
Validations:
|
|
tenant[mailing_address_attributes][postal]
required |
Validations:
|
|
tenant[contacts_attributes]
optional |
A collection of contacts. Validations:
|
|
tenant[contacts_attributes][id]
optional |
Contact id required to update a contact. Validations:
|
|
tenant[contacts_attributes][first_name]
optional |
Validations:
|
|
tenant[contacts_attributes][middle_initial]
optional |
Validations:
|
|
tenant[contacts_attributes][last_name]
optional |
Validations:
|
|
tenant[contacts_attributes][email]
optional |
Validations:
|
|
tenant[contacts_attributes][description]
required |
Contact description Validations:
|
|
tenant[contacts_attributes][primary]
optional |
Flag that indicates if this is the primary contact of the tenant Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes]
optional |
A collection of phone numbers. Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][number]
optional |
Phone number Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][extension]
optional |
Phone number extension Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
tenant[contacts_attributes][phone_numbers_attributes][primary]
optional |
Flag that specifies if this is the primary phone number of the contact Validations:
|
|
tenant[contacts_attributes][address_attributes]
optional |
A collection of addresses. Validations:
|
|
tenant[contacts_attributes][address_attributes][address1]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][address2]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][city]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][state]
optional |
Validations:
|
|
tenant[contacts_attributes][address_attributes][postal]
optional |
Validations:
|
|
id
required |
Validations:
|
Examples
POST /v1/f70970d2-541c-4f2e-891a-3fe58f23e682/tenants/40d80a3c-e03a-46bb-aed7-d56ccf1b8529/sign_up
{
"tenant": {
"username": "awesome_o_5000",
"password": "supersecretpassword"
}
}
200
{
"tenant": {
"id": "40d80a3c-e03a-46bb-aed7-d56ccf1b8529",
"account_number": 1000002,
"first_name": "Hana65",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "awesome_o_5000",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": true,
"created_at": "2023-09-15T04:37:30.604-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "8391fed7-a96a-4b6a-a55e-ff1c10e3e82d",
"address1": "494446 Glenda Plains",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "494446 Glenda Plains, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "8391fed7-a96a-4b6a-a55e-ff1c10e3e82d",
"address1": "494446 Glenda Plains",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "494446 Glenda Plains, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "f70970d2-541c-4f2e-891a-3fe58f23e682",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"fdb6df51-40b3-4a0f-9bcf-7117243246a8",
"26e6cd26-795a-4aff-baad-5c63e7347338"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"tenant": {
"username": "awesome_o_5000",
"password": "[FILTERED]"
},
"facility_id": "f70970d2-541c-4f2e-891a-3fe58f23e682",
"tenant_id": "40d80a3c-e03a-46bb-aed7-d56ccf1b8529"
}
}
}
PUT /v1/:facility_id/tenants/:tenant_id/change_password
Change a tenant's password by providing the old one
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
|
current_password
required |
Validations:
|
|
new_password
required |
Validations:
|
Examples
PUT /v1/975d1d99-13f2-4019-a81c-964f955fe35e/tenants/2632c11e-5d1a-4dd5-b575-58131223f740/change_password
{
"tenant": {
"current_password": "super_secret_password",
"new_password": "super_new_password"
}
}
200
{
"tenant": {
"id": "2632c11e-5d1a-4dd5-b575-58131223f740",
"account_number": 1000002,
"first_name": "Carlos71",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "[email protected]",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": true,
"created_at": "2023-09-15T04:37:33.340-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "e57d4d91-b73f-400c-addc-64905415d6d1",
"address1": "51477187 Cremin Streets",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "51477187 Cremin Streets, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "e57d4d91-b73f-400c-addc-64905415d6d1",
"address1": "51477187 Cremin Streets",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "51477187 Cremin Streets, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "975d1d99-13f2-4019-a81c-964f955fe35e",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"c7974efc-3aed-48a1-a296-4e10660f6bf7",
"b0ec67ec-ae9b-4ec1-9201-d5c358514f85"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"tenant": {
"current_password": "[FILTERED]",
"new_password": "[FILTERED]"
},
"facility_id": "975d1d99-13f2-4019-a81c-964f955fe35e",
"tenant_id": "2632c11e-5d1a-4dd5-b575-58131223f740"
}
}
}
POST /v1/:facility_id/tenants/reset_password_with_token
Resets the tenant's password given a reset token and new password
Params
| Param name | Description |
|---|---|
|
reset_token
required |
Validations:
|
|
password
required |
Validations:
|