Tenants
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/1728aed1-8dd9-430d-a71c-4224e521ce59/tenants
200
{
"tenants": [
{
"id": "747702e2-7306-4dc5-a1f3-3c70ad359606",
"account_number": 1000000,
"first_name": "Lyman79",
"last_name": "Wehner",
"middle_initial": null,
"email": "cristobalshields@zemlak.name79",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"ab5b97d4-336e-411b-aa50-c2fc1e3c27ef"
],
"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": "2022-09-12T22:36:47.055-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "8dfd4485-088e-4c8e-bf1b-23161588fd28",
"primary": true,
"source": null,
"number": "+15515633962",
"formatted_number": "(551) 563-3962 x 2910",
"extension": "2910",
"label": "Other",
"unformatted_number": "5515633962",
"sms_opt_in": false
},
{
"id": "fccef6f0-44f9-431b-91f7-e37714c2bfed",
"primary": false,
"source": null,
"number": "+12265108795",
"formatted_number": "(226) 510-8795",
"extension": null,
"label": "Home",
"unformatted_number": "2265108795",
"sms_opt_in": false
},
{
"id": "acce7f63-58fe-49b0-ac48-9863faefc85d",
"primary": false,
"source": null,
"number": "+19405716656",
"formatted_number": "(940) 571-6656 x 3860",
"extension": "3860",
"label": "Pager",
"unformatted_number": "9405716656",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "48151b12-6a27-4c97-ac7a-db410a2f201b",
"address1": "41537686 Benjamin Glen",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "41537686 Benjamin Glen, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "48151b12-6a27-4c97-ac7a-db410a2f201b",
"address1": "41537686 Benjamin Glen",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "41537686 Benjamin Glen, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "1728aed1-8dd9-430d-a71c-4224e521ce59",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"4f1b2e4b-d8f6-4683-b444-8bb3e598f29a"
],
"password_recovery_question_ids": [
"f9057def-af76-43db-93f4-3736c6689c2b",
"05e8c81b-fbd7-475a-94f5-36a3f39128c5"
]
},
{
"id": "d4d0a4de-a574-4df2-8f77-1d7875d63859",
"account_number": 1000001,
"first_name": "Hipolito80",
"last_name": "Wehner",
"middle_initial": null,
"email": "ronniemarvin@oconner.co80",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"1a237b46-2c4d-45c8-99f9-01d770d5384f"
],
"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": "2022-09-12T22:36:47.292-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "79f54d79-59b2-4f50-901b-cb842375f85f",
"primary": true,
"source": null,
"number": "+14194353362",
"formatted_number": "(419) 435-3362",
"extension": null,
"label": "Mobile",
"unformatted_number": "4194353362",
"sms_opt_in": false
},
{
"id": "11ef132a-6ed6-4f42-b5fe-c1a6db709370",
"primary": false,
"source": null,
"number": "+15637088367",
"formatted_number": "(563) 708-8367",
"extension": null,
"label": "Home",
"unformatted_number": "5637088367",
"sms_opt_in": false
},
{
"id": "fed7a574-8a39-4f6a-8760-585be309a83e",
"primary": false,
"source": null,
"number": "+13868485784",
"formatted_number": "(386) 848-5784",
"extension": null,
"label": "Other",
"unformatted_number": "3868485784",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "ce71d370-3b4c-4af8-9ec5-a26b921bbb0c",
"address1": "416136 Hector Forks",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "416136 Hector Forks, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "ce71d370-3b4c-4af8-9ec5-a26b921bbb0c",
"address1": "416136 Hector Forks",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "416136 Hector Forks, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "1728aed1-8dd9-430d-a71c-4224e521ce59",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"23e963a8-9934-46c1-ab21-bccc39c485de"
],
"password_recovery_question_ids": [
"e676fceb-d5e1-42e8-a7d6-1c5bd62c1fac",
"e15e54bb-19ae-446e-8b97-8d609632b590"
]
}
],
"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": "1728aed1-8dd9-430d-a71c-4224e521ce59"
}
}
}
GET /v1/:facility_id/tenants/previous
Shows all previous (moved-out) tenants
Examples
GET /v1/4a5f09d4-2cc9-4c6e-bcec-4f5daf36d6c2/tenants/previous
200
{
"tenants": [
{
"id": "b0853944-b63f-47ea-9f67-84b855892148",
"account_number": 1000000,
"first_name": "Tambra81",
"last_name": "Wehner",
"middle_initial": null,
"email": "willis@tromp.com81",
"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_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": "2022-09-12T22:36:47.744-10:00",
"gate_24_hour_access": false,
"active": false,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "e2118e06-e386-4515-a155-db1dc1578286",
"primary": true,
"source": null,
"number": "+15104458634",
"formatted_number": "(510) 445-8634 x 3584",
"extension": "3584",
"label": "Other",
"unformatted_number": "5104458634",
"sms_opt_in": false
},
{
"id": "69dec8f8-f29a-479d-a54c-edd736d8a131",
"primary": false,
"source": null,
"number": "+14159161730",
"formatted_number": "(415) 916-1730 x 8870",
"extension": "8870",
"label": "Pager",
"unformatted_number": "4159161730",
"sms_opt_in": false
},
{
"id": "122c06da-1c72-4878-a61f-a552bf386ccd",
"primary": false,
"source": null,
"number": "+15078087082",
"formatted_number": "(507) 808-7082",
"extension": null,
"label": "Fax",
"unformatted_number": "5078087082",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "d980c9cc-2484-46aa-accf-397cca26acbd",
"address1": "422582 Shin Mountains",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "422582 Shin Mountains, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "d980c9cc-2484-46aa-accf-397cca26acbd",
"address1": "422582 Shin Mountains",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "422582 Shin Mountains, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "4a5f09d4-2cc9-4c6e-bcec-4f5daf36d6c2",
"previous_ledger_ids": [
"bbb62a03-5892-42a8-9bbe-66515330f3fe"
],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"a58dafd0-41e4-4089-98a8-9f6cd662fb13"
],
"password_recovery_question_ids": [
"c55927a9-f4a2-4d00-a29d-2a2e144c27c3",
"5e084416-aaa5-4822-8537-13897dc69543"
]
}
],
"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": "4a5f09d4-2cc9-4c6e-bcec-4f5daf36d6c2"
}
}
}
GET /v1/:facility_id/tenants/current
Shows all current tenants
Examples
GET /v1/ce5ca651-f892-4923-bd7e-e21a63b24734/tenants/current
200
{
"tenants": [
{
"id": "4db79fa7-5286-4acc-9652-c9c46eac3377",
"account_number": 1000000,
"first_name": "Roselyn83",
"last_name": "Wehner",
"middle_initial": null,
"email": "robertoupton@hintzvon.biz83",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"bbd631bd-ece6-42ce-b7a3-82f6038f9c25"
],
"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_83",
"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": "2022-09-12T22:36:48.389-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "f19edb60-9c11-4eaa-85d4-4209365828ca",
"primary": true,
"source": null,
"number": "+19568187824",
"formatted_number": "(956) 818-7824 x 2275",
"extension": "2275",
"label": "Other",
"unformatted_number": "9568187824",
"sms_opt_in": false
},
{
"id": "56c1b81a-3f89-45db-87cd-d2b65e4b3bfc",
"primary": false,
"source": null,
"number": "+16102523288",
"formatted_number": "(610) 252-3288",
"extension": null,
"label": "Mobile",
"unformatted_number": "6102523288",
"sms_opt_in": false
},
{
"id": "ffcb9697-1990-41b4-8986-45618657734a",
"primary": false,
"source": null,
"number": "+17734257710",
"formatted_number": "(773) 425-7710 x 3819",
"extension": "3819",
"label": "Mobile",
"unformatted_number": "7734257710",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "67a4b680-92b1-4b1e-8583-c9dc44bed973",
"address1": "429787 Schmidt Spur",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "429787 Schmidt Spur, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "67a4b680-92b1-4b1e-8583-c9dc44bed973",
"address1": "429787 Schmidt Spur",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "429787 Schmidt Spur, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "ce5ca651-f892-4923-bd7e-e21a63b24734",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"6689c57c-ad77-46dd-9db7-3eb3538699e5"
],
"password_recovery_question_ids": [
"7bb5dbd2-07f8-46a4-9cf5-bfdc57710756",
"903456ea-0c79-44b0-a7e1-b6cabe7da40c"
]
},
{
"id": "a8593bc8-2830-4a1c-9234-c7eb5d6af492",
"account_number": 1000001,
"first_name": "Oda84",
"last_name": "Wehner",
"middle_initial": null,
"email": "spencer@kiehncarter.io84",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"2ec91b4b-e3a8-4a99-910d-2171be9ceedb"
],
"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_84",
"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": "2022-09-12T22:36:48.531-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "36110eab-d88f-48ed-ba8f-ece3ff62f743",
"primary": true,
"source": null,
"number": "+19099789593",
"formatted_number": "(909) 978-9593 x 7935",
"extension": "7935",
"label": "Mobile",
"unformatted_number": "9099789593",
"sms_opt_in": false
},
{
"id": "10d397b1-6e29-4755-8216-ad3fec7ec15c",
"primary": false,
"source": null,
"number": "+19193173701",
"formatted_number": "(919) 317-3701",
"extension": null,
"label": "Pager",
"unformatted_number": "9193173701",
"sms_opt_in": false
},
{
"id": "048cff16-5979-4a0a-a4e1-11f1fea42ebe",
"primary": false,
"source": null,
"number": "+15158703791",
"formatted_number": "(515) 870-3791 x 8195",
"extension": "8195",
"label": "Mobile",
"unformatted_number": "5158703791",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "72fd943e-e36a-4e3e-91b4-80da8ce268ce",
"address1": "43011678 Quitzon Knoll",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "43011678 Quitzon Knoll, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "72fd943e-e36a-4e3e-91b4-80da8ce268ce",
"address1": "43011678 Quitzon Knoll",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "43011678 Quitzon Knoll, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "ce5ca651-f892-4923-bd7e-e21a63b24734",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"0ec170a0-9d8c-4beb-ade2-85eca5487053"
],
"password_recovery_question_ids": [
"a9824100-a6f8-4031-8dab-efa072778dd1",
"c0e9a3a4-d6bf-4cdc-b6f6-97b1094a4d96"
]
}
],
"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": "ce5ca651-f892-4923-bd7e-e21a63b24734"
}
}
}
GET /v1/:facility_id/tenants/:id
Show a particular tenant
Examples
GET /v1/f8ca22db-c418-4207-9a34-5dd0e8dfdddf/tenants/fd673924-8ce9-433b-8d68-0c8a1c760484
200
{
"tenant": {
"id": "fd673924-8ce9-433b-8d68-0c8a1c760484",
"account_number": 1000000,
"first_name": "Kendall77",
"last_name": "Wehner",
"middle_initial": null,
"email": "belia@braun.net77",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"da49e344-8c84-47d5-b483-f1b0cf3214aa"
],
"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_77",
"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": "2022-09-12T22:36:46.511-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "bddbf407-1e46-4f8e-b144-123be2bed202",
"primary": true,
"source": null,
"number": "+18456081336",
"formatted_number": "(845) 608-1336",
"extension": null,
"label": "Pager",
"unformatted_number": "8456081336",
"sms_opt_in": false
},
{
"id": "dabb9d35-f780-49ea-8b4f-a314a4f2a1b8",
"primary": false,
"source": null,
"number": "+17656620231",
"formatted_number": "(765) 662-0231",
"extension": null,
"label": "Mobile",
"unformatted_number": "7656620231",
"sms_opt_in": false
},
{
"id": "eff428d3-3b09-48c8-a55c-467ede842998",
"primary": false,
"source": null,
"number": "+17323865872",
"formatted_number": "(732) 386-5872",
"extension": null,
"label": "Pager",
"unformatted_number": "7323865872",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "94c415a3-273c-4640-b158-3de15d5dc81c",
"address1": "4086761 Hilpert Roads",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "4086761 Hilpert Roads, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "94c415a3-273c-4640-b158-3de15d5dc81c",
"address1": "4086761 Hilpert Roads",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "4086761 Hilpert Roads, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "f8ca22db-c418-4207-9a34-5dd0e8dfdddf",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"0a6c5ac6-945d-4744-94d0-5de5f9a3465b"
],
"password_recovery_question_ids": [
"f7b1c77c-9e1d-4813-9984-13620ae0f237",
"9b76c231-bb85-4b63-9896-54eb800314ed"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "f8ca22db-c418-4207-9a34-5dd0e8dfdddf",
"id": "fd673924-8ce9-433b-8d68-0c8a1c760484"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
POST /v1/:facility_id/tenants/username_lookup
Lookup tenant based on username
Examples
POST /v1/7de94f93-58a2-482b-92fd-f3b0da57a174/tenants/username_lookup
{
"username": "exampleuser@someone.com"
}
200
{
"tenant": {
"id": "c965cd0c-0f11-46f7-90cb-aace9584c274",
"account_number": 1000002,
"first_name": "Example tenant",
"last_name": "Wehner",
"middle_initial": null,
"email": "amie@harber.org92",
"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": "exampleuser@someone.com",
"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": "2022-09-12T22:36:50.528-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": "7adfc81c-8f95-4326-b798-2c17ab869c91",
"address1": "455847 Heidenreich Circles",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "455847 Heidenreich Circles, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "7adfc81c-8f95-4326-b798-2c17ab869c91",
"address1": "455847 Heidenreich Circles",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "455847 Heidenreich Circles, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "7de94f93-58a2-482b-92fd-f3b0da57a174",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"067700de-8897-41a6-b85a-94481b5fe6f4",
"2746160d-2467-46fe-b8bf-27f49d4ce981"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"username": "exampleuser@someone.com",
"facility_id": "7de94f93-58a2-482b-92fd-f3b0da57a174"
}
}
}
Params
| Param name | Description |
|---|---|
|
tenant optional |
Value: Must be a Hash |
|
tenant[username] required |
Value: Must be a String |
POST /v1/:facility_id/tenants/forgot_username
Recover username based on account number
Examples
POST /v1/20dc7193-a127-4d19-aacb-55a1a4818f94/tenants/forgot_username
{
"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": "20dc7193-a127-4d19-aacb-55a1a4818f94"
}
}
}
Params
| Param name | Description |
|---|---|
|
tenant optional |
Value: Must be a Hash |
|
tenant[account_number] required |
Value: Must be a String |
GET /v1/:facility_id/tenants/search
Search Tenants by phone number or account code.
Examples
GET /v1/0c1e9b1e-a77a-4e70-a897-eb88e34d1f70/tenants/search
200
{
"tenants": [
{
"id": "53d76880-ee97-4e91-bfb7-44e863443aa6",
"account_number": 123456,
"first_name": "Example tenant",
"last_name": "Wehner",
"middle_initial": null,
"email": "chin@hane.org89",
"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": "exampleuser@someone.com",
"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": "2022-09-12T22:36:49.907-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": "1f92f6da-b23b-45ba-9594-16b791c0c601",
"address1": "44785046 Roman Lane",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "44785046 Roman Lane, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "1f92f6da-b23b-45ba-9594-16b791c0c601",
"address1": "44785046 Roman Lane",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "44785046 Roman Lane, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "0c1e9b1e-a77a-4e70-a897-eb88e34d1f70",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"e115b79b-8615-4674-a959-f35956d9b210",
"69193e95-a65c-4d95-ac12-8d9542a8c6c5"
]
}
],
"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": "0c1e9b1e-a77a-4e70-a897-eb88e34d1f70"
}
}
}
Params
| Param name | Description |
|---|---|
|
phone_number optional |
Phone number of the tenant. Either phonenumber or accountnumber is required, but not both. Value: Must be a String |
|
account_number optional |
Account number of the tenant. Either phonenumber or accountnumber is required, but not both. Value: Must be a String |
GET /v1/:facility_id/tenants/:tenant_id/eligibility
Show a tenant's eligibility to move in or perform other actions in storEDGE
Examples
GET /v1/36cbe51f-9144-4a0c-ad99-4abf13cf0479/tenants/b09a2d0b-a8a9-402f-b0a2-d383283cbe98/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": "36cbe51f-9144-4a0c-ad99-4abf13cf0479",
"tenant_id": "b09a2d0b-a8a9-402f-b0a2-d383283cbe98"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
GET /v1/:facility_id/tenants/:tenant_id/notes
Show a tenants notes
Examples
GET /v1/758fbf33-eed5-4ef9-91d8-d1ad3ccd8aed/tenants/01b1b749-b008-4981-a4c0-187a60f05423/notes
200
{
"notes": [
{
"id": "eeccbcb1-aec0-4eef-8988-09a21978498e",
"note": "test",
"created_at": "2020-08-20T08:41:40.570-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": "758fbf33-eed5-4ef9-91d8-d1ad3ccd8aed",
"tenant_id": "01b1b749-b008-4981-a4c0-187a60f05423"
}
}
}
GET /v1/:facility_id/tenants/:tenant_id/delinquency
Show a tenant's delinquency status
Examples
GET /v1/f829a8f5-1605-480f-9f2f-3cadad08e3c0/tenants/a3968803-7e5e-47d8-8db4-6850fd41f1a2/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": "f829a8f5-1605-480f-9f2f-3cadad08e3c0",
"tenant_id": "a3968803-7e5e-47d8-8db4-6850fd41f1a2"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
GET /v1/:facility_id/tenants/:tenant_id/preferences
Show a tenants preferences
Examples
GET /v1/e7efaf0a-50c5-4c4b-9303-eeb3dc5ae499/tenants/ca4b72f3-abc7-4d13-9181-bae7c13a4ecc/preferences
200
{
"tenant_settings": {
"id": "0450d514-b132-4c66-b5fb-cae4d7517a61",
"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": "e7efaf0a-50c5-4c4b-9303-eeb3dc5ae499",
"tenant_id": "ca4b72f3-abc7-4d13-9181-bae7c13a4ecc"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
PUT /v1/:facility_id/tenants/:tenant_id/preferences
Update a tenants preferences
Examples
PUT /v1/d9356edc-6d2a-43b2-91ac-c71fa6f012d7/tenants/dfcb7de5-ca0d-4934-b893-7955d237e949/preferences
{
"tenant_settings": {
"delinquency_exempt": "true"
}
}
200
{
"tenant_settings": {
"id": "e904f2a9-5993-4b5f-a207-20955380bd16",
"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": true,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": true
}
},
"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": "d9356edc-6d2a-43b2-91ac-c71fa6f012d7",
"tenant_id": "dfcb7de5-ca0d-4934-b893-7955d237e949"
}
}
}
GET /v1/:facility_id/tenants/:tenant_id/ledgers
Show a tenants current ledgers
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
PATCH /v1/:facility_id/tenants/:id
Update a tenant
PUT /v1/:facility_id/tenants/:id
Update a tenant
Examples
PUT /v1/017f8870-44d0-46ae-b2ac-bfec8c1faf85/tenants/78cc61ec-9f63-4988-9b81-dfd6cce52038
{
"tenant": {
"first_name": "Kelvin",
"last_name": "Benjamin",
"mailing_address_attributes": {
"address1": "Ikea St",
"city": "Ikealand",
"state": "KS"
},
"phone_numbers_attributes": [
{
"label": "Mobile",
"number": "5656663476",
"sms_opt_in": "true"
}
]
}
}
200
{
"tenant": {
"id": "78cc61ec-9f63-4988-9b81-dfd6cce52038",
"account_number": 1000000,
"first_name": "Kelvin",
"last_name": "Benjamin",
"middle_initial": null,
"email": "elishahansen@murazik.net75",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"a5282b86-b325-48c3-a199-6fba60193140"
],
"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_75",
"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": "2022-09-12T22:36:45.896-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "7f54b3e8-b773-4264-941d-e1fc2208487a",
"primary": true,
"source": null,
"number": "+15707341455",
"formatted_number": "(570) 734-1455 x 5237",
"extension": "5237",
"label": "Home",
"unformatted_number": "5707341455",
"sms_opt_in": false
},
{
"id": "82bb506c-5425-4cc1-89d9-66c2273160d9",
"primary": false,
"source": null,
"number": "+16197759199",
"formatted_number": "(619) 775-9199 x 2097",
"extension": "2097",
"label": "Fax",
"unformatted_number": "6197759199",
"sms_opt_in": false
},
{
"id": "c8aa1c63-9345-4cf4-9982-3d45b9a4fbc7",
"primary": false,
"source": null,
"number": "+17542122773",
"formatted_number": "(754) 212-2773 x 2929",
"extension": "2929",
"label": "Pager",
"unformatted_number": "7542122773",
"sms_opt_in": false
},
{
"id": null,
"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": "589229c0-155a-4dfe-9897-9fc6d89ef9a5",
"address1": "Ikea St",
"address2": null,
"city": "Ikealand",
"state": "KS",
"postal": "39384",
"country": "US",
"full_address": "Ikea St, Ikealand, KS 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "589229c0-155a-4dfe-9897-9fc6d89ef9a5",
"address1": "Ikea St",
"address2": null,
"city": "Ikealand",
"state": "KS",
"postal": "39384",
"country": "US",
"full_address": "Ikea St, Ikealand, KS 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
},
{
"id": "589229c0-155a-4dfe-9897-9fc6d89ef9a5",
"address1": "Ikea St",
"address2": null,
"city": "Ikealand",
"state": "KS",
"postal": "39384",
"country": "US",
"full_address": "Ikea St, Ikealand, KS 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "017f8870-44d0-46ae-b2ac-bfec8c1faf85",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"8e7249fd-01d5-4974-a905-fd3c3abf3cfb"
],
"password_recovery_question_ids": [
"de7d1e7a-ef5b-4ea8-b77a-a083944330d6",
"940880bb-acbe-4db0-969f-e81e1b6110d7"
]
},
"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",
"mailing_address_attributes": {
"address1": "Ikea St",
"city": "Ikealand",
"state": "KS"
},
"phone_numbers_attributes": [
{
"label": "Mobile",
"number": "5656663476",
"sms_opt_in": "true"
}
]
},
"facility_id": "017f8870-44d0-46ae-b2ac-bfec8c1faf85",
"id": "78cc61ec-9f63-4988-9b81-dfd6cce52038"
}
}
}
Params
| Param name | Description |
|---|---|
|
tenant optional |
Value: Must be a Hash |
|
tenant[first_name] optional |
Value: Must be a String |
|
tenant[account_number] optional |
Value: Must be a String |
|
tenant[middle_initial] optional |
Value: Must be a String |
|
tenant[last_name] optional |
Value: Must be a String |
|
tenant[drivers_license_number] optional |
Value: Must be a String |
|
tenant[drivers_license_state] optional |
Value: Must be a String |
|
tenant[vehicle_license_plate_number] optional |
Value: Must be a String |
|
tenant[vehicle_license_state] optional |
Value: Must be a String |
|
tenant[vehicle_description] optional |
Value: Must be a String |
|
tenant[email] optional |
Value: Must be a String |
|
tenant[username] optional |
Value: Must be a String |
|
tenant[password] optional |
Value: Must be a String |
|
tenant[tax_exempt] optional |
Is the tenant tax exempt? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[is_military] optional |
Is the tenant military? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[is_business] optional |
Is the tenant a business? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[business_name] optional |
Value: Must be a String |
|
tenant[title] optional |
Value: Must be a String |
|
tenant[decline_alternate_contact] optional |
Whether or not the tenant declined to provide alternate contact information Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[military_information] optional |
A collection of military information (if is_military is true). Value: Must be a Hash |
|
tenant[military_information][retired_military] optional |
Is the tenant retired military? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[military_information][no_agent_given] optional |
Is agent information provided? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[military_information][date_entered_service] optional |
Date entered service, Format: YYYY-MM-DD Value: Must be a Date |
|
tenant[military_information][military_id] optional |
Value: Must be a String |
|
tenant[military_information][end_of_active_service_date] optional |
End date of active service, Format: YYYY-MM-DD Value: Must be a Date |
|
tenant[military_information][place_of_birth] optional |
Value: Must be a String |
|
tenant[military_information][last_4_of_ssn] optional |
Must be a 4 digit number Value: Must be a String |
|
tenant[military_information][military_email_address] optional |
Must be a valid email address Value: Must be a String |
|
tenant[military_information][military_rank] optional |
Value: Must be a String |
|
tenant[military_information][current_duty_location] optional |
Value: Must be a String |
|
tenant[military_information][branch_of_service] optional |
Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other Value: Must be a String |
|
tenant[military_information][military_unit] optional |
Value: Must be a String |
|
tenant[military_information][squadron] optional |
Value: Must be a String |
|
tenant[military_information][division] optional |
Value: Must be a String |
|
tenant[military_information][type_of_service] optional |
Must be Active Component or Veteran Value: Must be a String |
|
tenant[military_information][agent_first_name] optional |
Value: Must be a String |
|
tenant[military_information][agent_last_name] optional |
Value: Must be a String |
|
tenant[military_information][agent_email_address] optional |
Must be a valid email address Value: Must be a String |
|
tenant[military_information][agent_phone_number] optional |
Must be a valid phone number Value: Must be a String |
|
tenant[military_information][agent_address] optional |
Value: Must be a String |
|
tenant[military_information][agent_city] optional |
Value: Must be a String |
|
tenant[military_information][agent_state] optional |
Must be a valid state abbreviation Value: Must be a String |
|
tenant[military_information][agent_postal_code] optional |
Must be a valid US postal code Value: Must be a String |
|
tenant[military_information][officer_first_name] optional |
Value: Must be a String |
|
tenant[military_information][officer_last_name] optional |
Value: Must be a String |
|
tenant[military_information][officer_phone_number] optional |
Must be a valid phone number Value: Must be a String |
|
tenant[password_recovery_questions_attributes] optional |
Password recovery questions Value: Must be an Array of nested elements |
|
tenant[password_recovery_questions_attributes][question] required |
Value: Must be a String |
|
tenant[password_recovery_questions_attributes][answer] required |
Value: Must be a String |
|
tenant[phone_numbers_attributes] required |
A collection of phone numbers. Value: Must be an Array of nested elements |
|
tenant[phone_numbers_attributes][number] optional |
Phone number Value: Must be a String |
|
tenant[phone_numbers_attributes][extension] required |
Phone number extension Value: Must be a String |
|
tenant[phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
tenant[phone_numbers_attributes][primary] optional |
Flag that indicates if this is the primary phone number of the tenant Value: Must be a String |
|
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. Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[mailing_address_attributes] required |
A collection of addresses. Value: Must be a Hash |
|
tenant[mailing_address_attributes][address1] required |
Value: Must be a String |
|
tenant[mailing_address_attributes][address2] optional |
Value: Must be a String |
|
tenant[mailing_address_attributes][city] required |
Value: Must be a String |
|
tenant[mailing_address_attributes][state] required |
Value: Must be a String |
|
tenant[mailing_address_attributes][postal] required |
Value: Must be a String |
|
tenant[contacts_attributes] optional |
A collection of contacts. Value: Must be an Array of nested elements |
|
tenant[contacts_attributes][first_name] optional |
Value: Must be a String |
|
tenant[contacts_attributes][middle_initial] optional |
Value: Must be a String |
|
tenant[contacts_attributes][last_name] optional |
Value: Must be a String |
|
tenant[contacts_attributes][email] optional |
Value: Must be a String |
|
tenant[contacts_attributes][description] required |
Contact description Value: Must be a String |
|
tenant[contacts_attributes][primary] optional |
Flag that indicates if this is the primary contact of the tenant Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes] optional |
A collection of phone numbers. Value: Must be an Array of nested elements |
|
tenant[contacts_attributes][phone_numbers_attributes][number] optional |
Phone number Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes][extension] optional |
Phone number extension Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes][primary] optional |
Flag that specifies if this is the primary phone number of the contact Value: Must be a String |
|
tenant[contacts_attributes][address_attributes] optional |
A collection of addresses. Value: Must be a Hash |
|
tenant[contacts_attributes][address_attributes][address1] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][address2] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][city] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][state] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][postal] optional |
Value: Must be a String |
POST /v1/:facility_id/tenants/sign_in
Sign a tenant in
Examples
POST /v1/21da8bfd-a358-4f00-808f-74f08b9d9687/tenants/sign_in
{
"tenant": {
"login": "mitchellbartell@thiel.io68",
"password": "super_secret_password"
}
}
200
{
"tenant": {
"id": "d5a0552a-2c03-46f0-b325-02e2decb42dc",
"account_number": 1000002,
"first_name": "Rich68",
"last_name": "Wehner",
"middle_initial": null,
"email": "mitchellbartell@thiel.io68",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": "2022-09-12T22:36:44.512-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": "mitchellbartell@thiel.io68",
"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": "2022-09-12T22:36:44.481-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": "8531aea8-a82f-4ad7-b0a0-51d081186095",
"address1": "381246 Langworth Hill",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "381246 Langworth Hill, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "8531aea8-a82f-4ad7-b0a0-51d081186095",
"address1": "381246 Langworth Hill",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "381246 Langworth Hill, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "21da8bfd-a358-4f00-808f-74f08b9d9687",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"ed5b60d3-8ca2-4f39-abf3-a310bbf83482",
"c01ae1a0-6dd4-411d-b855-2e72cdaeb90a"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"tenant": {
"login": "mitchellbartell@thiel.io68",
"password": "[FILTERED]"
},
"facility_id": "21da8bfd-a358-4f00-808f-74f08b9d9687"
}
}
}
Params
| Param name | Description |
|---|---|
|
tenant optional |
Value: Must be a Hash |
|
tenant[login] required |
Can be either an email or username. Value: Must be a String |
|
tenant[password] required |
Value: Must be a String |
|
tenant[facility_uuid] optional |
Value: Must be a String |
POST /v1/:facility_id/tenants/:tenant_id/sign_up
Sign up for a tenant portal account
Examples
POST /v1/29eaee94-95a2-488a-b84c-bb9b86931195/tenants/c4b408fe-c693-4080-bbea-e8a6b06ecd52/sign_up
{
"tenant": {
"password": "supersecretpassword",
"username": "awesome_o_5000"
}
}
200
{
"tenant": {
"id": "c4b408fe-c693-4080-bbea-e8a6b06ecd52",
"account_number": 1000002,
"first_name": "Loni74",
"last_name": "Wehner",
"middle_initial": null,
"email": "patrickschimmel@hayes.co74",
"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": "2022-09-12T22:36:45.670-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": "4eb3f188-bb10-4f3d-b490-f1823cae6e0d",
"address1": "397401 Jennefer Mall",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "397401 Jennefer Mall, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "4eb3f188-bb10-4f3d-b490-f1823cae6e0d",
"address1": "397401 Jennefer Mall",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "397401 Jennefer Mall, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "29eaee94-95a2-488a-b84c-bb9b86931195",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"47b98425-f1c3-4810-b2ac-a17088ec8a3a",
"abca3bce-bb8f-4ea2-9f5d-e471ae6b8286"
]
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "POST",
"request_id": null,
"parameters": {
"tenant": {
"password": "[FILTERED]",
"username": "awesome_o_5000"
},
"facility_id": "29eaee94-95a2-488a-b84c-bb9b86931195",
"tenant_id": "c4b408fe-c693-4080-bbea-e8a6b06ecd52"
}
}
}
Params
| Param name | Description |
|---|---|
|
tenant optional |
Value: Must be a Hash |
|
tenant[first_name] optional |
Value: Must be a String |
|
tenant[account_number] optional |
Value: Must be a String |
|
tenant[middle_initial] optional |
Value: Must be a String |
|
tenant[last_name] optional |
Value: Must be a String |
|
tenant[drivers_license_number] optional |
Value: Must be a String |
|
tenant[drivers_license_state] optional |
Value: Must be a String |
|
tenant[vehicle_license_plate_number] optional |
Value: Must be a String |
|
tenant[vehicle_license_state] optional |
Value: Must be a String |
|
tenant[vehicle_description] optional |
Value: Must be a String |
|
tenant[email] optional |
Value: Must be a String |
|
tenant[username] optional |
Value: Must be a String |
|
tenant[password] optional |
Value: Must be a String |
|
tenant[tax_exempt] optional |
Is the tenant tax exempt? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[is_military] optional |
Is the tenant military? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[is_business] optional |
Is the tenant a business? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[business_name] optional |
Value: Must be a String |
|
tenant[title] optional |
Value: Must be a String |
|
tenant[decline_alternate_contact] optional |
Whether or not the tenant declined to provide alternate contact information Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[military_information] optional |
A collection of military information (if is_military is true). Value: Must be a Hash |
|
tenant[military_information][retired_military] optional |
Is the tenant retired military? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[military_information][no_agent_given] optional |
Is agent information provided? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[military_information][date_entered_service] optional |
Date entered service, Format: YYYY-MM-DD Value: Must be a Date |
|
tenant[military_information][military_id] optional |
Value: Must be a String |
|
tenant[military_information][end_of_active_service_date] optional |
End date of active service, Format: YYYY-MM-DD Value: Must be a Date |
|
tenant[military_information][place_of_birth] optional |
Value: Must be a String |
|
tenant[military_information][last_4_of_ssn] optional |
Must be a 4 digit number Value: Must be a String |
|
tenant[military_information][military_email_address] optional |
Must be a valid email address Value: Must be a String |
|
tenant[military_information][military_rank] optional |
Value: Must be a String |
|
tenant[military_information][current_duty_location] optional |
Value: Must be a String |
|
tenant[military_information][branch_of_service] optional |
Must be Air Force, Army, Coast Guard, Marines, Navy, National Guard, or Other Value: Must be a String |
|
tenant[military_information][military_unit] optional |
Value: Must be a String |
|
tenant[military_information][squadron] optional |
Value: Must be a String |
|
tenant[military_information][division] optional |
Value: Must be a String |
|
tenant[military_information][type_of_service] optional |
Must be Active Component or Veteran Value: Must be a String |
|
tenant[military_information][agent_first_name] optional |
Value: Must be a String |
|
tenant[military_information][agent_last_name] optional |
Value: Must be a String |
|
tenant[military_information][agent_email_address] optional |
Must be a valid email address Value: Must be a String |
|
tenant[military_information][agent_phone_number] optional |
Must be a valid phone number Value: Must be a String |
|
tenant[military_information][agent_address] optional |
Value: Must be a String |
|
tenant[military_information][agent_city] optional |
Value: Must be a String |
|
tenant[military_information][agent_state] optional |
Must be a valid state abbreviation Value: Must be a String |
|
tenant[military_information][agent_postal_code] optional |
Must be a valid US postal code Value: Must be a String |
|
tenant[military_information][officer_first_name] optional |
Value: Must be a String |
|
tenant[military_information][officer_last_name] optional |
Value: Must be a String |
|
tenant[military_information][officer_phone_number] optional |
Must be a valid phone number Value: Must be a String |
|
tenant[password_recovery_questions_attributes] optional |
Password recovery questions Value: Must be an Array of nested elements |
|
tenant[password_recovery_questions_attributes][question] required |
Value: Must be a String |
|
tenant[password_recovery_questions_attributes][answer] required |
Value: Must be a String |
|
tenant[phone_numbers_attributes] required |
A collection of phone numbers. Value: Must be an Array of nested elements |
|
tenant[phone_numbers_attributes][number] optional |
Phone number Value: Must be a String |
|
tenant[phone_numbers_attributes][extension] required |
Phone number extension Value: Must be a String |
|
tenant[phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
tenant[phone_numbers_attributes][primary] optional |
Flag that indicates if this is the primary phone number of the tenant Value: Must be a String |
|
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. Value: Must be one of: <code>true</code>, <code>false</code>. |
|
tenant[mailing_address_attributes] required |
A collection of addresses. Value: Must be a Hash |
|
tenant[mailing_address_attributes][address1] required |
Value: Must be a String |
|
tenant[mailing_address_attributes][address2] optional |
Value: Must be a String |
|
tenant[mailing_address_attributes][city] required |
Value: Must be a String |
|
tenant[mailing_address_attributes][state] required |
Value: Must be a String |
|
tenant[mailing_address_attributes][postal] required |
Value: Must be a String |
|
tenant[contacts_attributes] optional |
A collection of contacts. Value: Must be an Array of nested elements |
|
tenant[contacts_attributes][first_name] optional |
Value: Must be a String |
|
tenant[contacts_attributes][middle_initial] optional |
Value: Must be a String |
|
tenant[contacts_attributes][last_name] optional |
Value: Must be a String |
|
tenant[contacts_attributes][email] optional |
Value: Must be a String |
|
tenant[contacts_attributes][description] required |
Contact description Value: Must be a String |
|
tenant[contacts_attributes][primary] optional |
Flag that indicates if this is the primary contact of the tenant Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes] optional |
A collection of phone numbers. Value: Must be an Array of nested elements |
|
tenant[contacts_attributes][phone_numbers_attributes][number] optional |
Phone number Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes][extension] optional |
Phone number extension Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
tenant[contacts_attributes][phone_numbers_attributes][primary] optional |
Flag that specifies if this is the primary phone number of the contact Value: Must be a String |
|
tenant[contacts_attributes][address_attributes] optional |
A collection of addresses. Value: Must be a Hash |
|
tenant[contacts_attributes][address_attributes][address1] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][address2] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][city] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][state] optional |
Value: Must be a String |
|
tenant[contacts_attributes][address_attributes][postal] optional |
Value: Must be a String |
|
id required |
Value: Must be a String |
PUT /v1/:facility_id/tenants/:tenant_id/change_password
Change a tenant's password by providing the old one
Examples
PUT /v1/0cfa194a-d53a-4b7a-b8ce-6b18b60c23e7/tenants/7e4a90c3-2588-43d6-99a9-9946eccd0f46/change_password
{
"tenant": {
"current_password": "super_secret_password",
"new_password": "super_new_password"
}
}
200
{
"tenant": {
"id": "7e4a90c3-2588-43d6-99a9-9946eccd0f46",
"account_number": 1000002,
"first_name": "Sparkle71",
"last_name": "Wehner",
"middle_initial": null,
"email": "charleyzulauf@runolfsdottirleuschke.biz71",
"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": "charleyzulauf@runolfsdottirleuschke.biz71",
"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": "2022-09-12T22:36:45.049-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": "fdc73672-2f1f-477d-aa71-c54f3fef79c3",
"address1": "3894303 Gerry Haven",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "3894303 Gerry Haven, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "fdc73672-2f1f-477d-aa71-c54f3fef79c3",
"address1": "3894303 Gerry Haven",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "3894303 Gerry Haven, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "0cfa194a-d53a-4b7a-b8ce-6b18b60c23e7",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [],
"password_recovery_question_ids": [
"059d7e91-1510-46a6-a165-df488924298a",
"19f7c2ac-bb55-4078-96f7-64e9e7930b1b"
]
},
"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": "0cfa194a-d53a-4b7a-b8ce-6b18b60c23e7",
"tenant_id": "7e4a90c3-2588-43d6-99a9-9946eccd0f46"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |
|
current_password required |
Value: Must be a String |
|
new_password required |
Value: Must be a String |
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 |
Value: Must be a String |
|
password required |
Value: Must be a String |