GET /v1/:facility_id/tenants/:tenant_id/preferences
Show a tenants preferences

Params

Param name Description
id
required

Validations:

  • Must be a String

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": {}
    }
  }
}