get https://{base_url}/api/invitations
Parameter
| Field | Type | Description |
|---|---|---|
page optional | Integer | Default value is 1 |
per_page optional | Integer | Default value is 20. Maximum 100 |
property_id optional | Integer | Smart Home asset unique ID |
status optional | String | Optional, Default value for search is 'all'. Allowed values are 'all', 'invited', 'accepted', 'move out initiated', 'moved out'. To search invitations against properties having hubs, pass search values like 'all' or 'invited' or 'accepted'. To search invitations against properties with oaks locks, pass search values like 'all' or 'invited' or 'accepted' or 'move out initiated' or 'moved out'. If include_deleted is passed as true, then 'denied', 'revoked' and 'removed' are allowed to search. |
name optional | String | Invitation Name |
email optional | String | Invitation Email |
phone optional | String | Invitation Phone Number |
account_id optional | String | Impersonate Account ID (or) all |
include_deleted optional | Boolean | Default value is false. Allowed values are true or false. Pass true to include deleted records. |
updated_after optional | String | Get list of invitation records which are updated on and after passed value. Allowed format YYYY-MM-DD. |