GET api/group/{id}/lettingssearching?pageSize={pageSize}&pageNumber={pageNumber}
Get Lettings Searching Roles for a Group Processes this group API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The unique identifier of the requested resource. |
integer |
Required |
| pageSize |
The page size value supplied with the request. |
integer |
Default value is 20 |
| pageNumber |
The page number value supplied with the request. |
integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
A list of Searching Roles
PagedCollectionDataContractOfGroupLettingsSearchingRoleDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount |
The total count value. |
integer |
None. |
| CurrentCount |
The current count value. |
integer |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| Collection |
The collection of collection. |
Collection of GroupLettingsSearchingRoleDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"Criteria": {
"TargetMoveIn": "2026-07-23T08:25:59.8225993Z",
"TermType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Students": true,
"IsSmoker": true,
"PetOwner": true,
"HousingBenefits": true,
"FurnishLevelType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"PriceType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"BudgetFrom": 5,
"BudgetTo": 1,
"NormalisedBudgetFrom": 6.1,
"NormalisedBudgetTo": 1.1,
"BudgetFlexible": true,
"MustHave": {
"MinimumBedrooms": 1,
"MaximumBedrooms": 1,
"Garage": true,
"HasGarden": true,
"MinimumReceptions": 4,
"MinimumBathrooms": 5,
"PropertyTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"PropertyTags": [
{
"Name": "sample string 1",
"Id": 2
},
{
"Name": "sample string 1",
"Id": 2
}
],
"Regions": [
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
}
],
"AddressId": 1
},
"ShouldHave": {
"PropertyTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"PropertyTags": [
{
"Name": "sample string 1",
"Id": 2
},
{
"Name": "sample string 1",
"Id": 2
}
]
},
"ShouldNotHave": {
"PropertyTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"PropertyTags": [
{
"Name": "sample string 1",
"Id": 2
},
{
"Name": "sample string 1",
"Id": 2
}
]
},
"MustNotHave": {
"Regions": [
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
}
]
}
},
"Description": "sample string 1",
"DislikedRoles": [
1,
2
],
"LikedRoles": [
1,
2
],
"ShouldRoles": [
1,
2
],
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"OwningTeamId": 2,
"BranchId": 3,
"GroupId": 4,
"Name": "sample string 5",
"TeamAccessType": "sample string 6",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CustomFields": [
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
},
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
}
],
"CreatedDate": "2026-07-23T08:25:59.8225993Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 8
},
{
"Criteria": {
"TargetMoveIn": "2026-07-23T08:25:59.8225993Z",
"TermType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Students": true,
"IsSmoker": true,
"PetOwner": true,
"HousingBenefits": true,
"FurnishLevelType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"PriceType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"BudgetFrom": 5,
"BudgetTo": 1,
"NormalisedBudgetFrom": 6.1,
"NormalisedBudgetTo": 1.1,
"BudgetFlexible": true,
"MustHave": {
"MinimumBedrooms": 1,
"MaximumBedrooms": 1,
"Garage": true,
"HasGarden": true,
"MinimumReceptions": 4,
"MinimumBathrooms": 5,
"PropertyTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"PropertyTags": [
{
"Name": "sample string 1",
"Id": 2
},
{
"Name": "sample string 1",
"Id": 2
}
],
"Regions": [
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
}
],
"AddressId": 1
},
"ShouldHave": {
"PropertyTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"PropertyTags": [
{
"Name": "sample string 1",
"Id": 2
},
{
"Name": "sample string 1",
"Id": 2
}
]
},
"ShouldNotHave": {
"PropertyTypes": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"PropertyTags": [
{
"Name": "sample string 1",
"Id": 2
},
{
"Name": "sample string 1",
"Id": 2
}
]
},
"MustNotHave": {
"Regions": [
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
},
{
"Id": 1,
"Name": "sample string 2",
"Type": "sample string 3",
"Source": "sample string 4"
}
]
}
},
"Description": "sample string 1",
"DislikedRoles": [
1,
2
],
"LikedRoles": [
1,
2
],
"ShouldRoles": [
1,
2
],
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"OwningTeamId": 2,
"BranchId": 3,
"GroupId": 4,
"Name": "sample string 5",
"TeamAccessType": "sample string 6",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CustomFields": [
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
},
{
"Name": "sample string 1",
"Values": [
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
},
{
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 1",
"Value": {}
}
]
}
],
"CreatedDate": "2026-07-23T08:25:59.8225993Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 8
}
]
}