Contents

# Buildium::ApplicantGroupSearchMessage

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **entity_type** | **String** | Filters results to any applicant groups associated with the specified entity identifier. This filter is used in conjunction with the `EntityType` field which must be set to the type of entity this identifier references. | [optional] |
| **entity_id** | **Integer** | Specifies the type of entity that `EntityId` refers to. This field is required if `EntityId` is specified. | [optional] |
| **application_group_statuses** | **Array<String>** | Filters results by the applicant group status. If no status is specified, applicant groups in any status will be returned. | [optional] |
| **unit_ids** | **Array<Integer>** | Filters results to applicant groups associated to any of the specified rental property unit identifiers. | [optional] |
| **name** | **String** | Filters results to applicant groups that includes applicants whose name *contains* the specified value. | [optional] |

## Example

```ruby
require 'buildium-ruby'

instance = Buildium::ApplicantGroupSearchMessage.new(
  entity_type: null,
  entity_id: null,
  application_group_statuses: null,
  unit_ids: null,
  name: null
)
```

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
buildium-ruby-3.0.0	docs/ApplicantGroupSearchMessage.md
buildium-ruby-2.1.0	docs/ApplicantGroupSearchMessage.md
buildium-ruby-2.0.1	docs/ApplicantGroupSearchMessage.md