GET api/key/all?pageSize={pageSize}&pageNumber={pageNumber}
Gets a summary of all keys in an agency. Processes this key API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| 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
The response returned after the operation completes.
PagedCollectionDataContractOfGetKeysDataContract| 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 GetKeysDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"Property": {
"Address": {
"OrganizationName": "sample string 1",
"Number": "sample string 2",
"BuildingName": "sample string 3",
"Street": "sample string 4",
"Town": "sample string 5",
"Locality": "sample string 6",
"County": "sample string 7",
"Postcode": "sample string 8",
"Id": 9
},
"Roles": [
{
"Id": 1,
"Name": "sample string 2",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"OwningBranch": {
"Id": 1,
"Name": "sample string 1"
}
},
{
"Id": 1,
"Name": "sample string 2",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"OwningBranch": {
"Id": 1,
"Name": "sample string 1"
}
}
],
"Id": 1
},
"Name": "sample string 1",
"Code": "sample string 2",
"IsCheckedOut": true,
"IsPermanent": true,
"CheckedInAt": "2026-08-05T01:28:48.5753357Z",
"CheckedInBy": {
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"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 4",
"Id": 5
},
"NoteOnCheckIn": "sample string 5",
"CheckedOutAt": "2026-08-05T01:28:48.5753357Z",
"CheckedOutBy": {
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"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 4",
"Id": 5
},
"NoteOnCheckOut": "sample string 6",
"RecipientDetails": {
"RecipientId": 1,
"RecipientName": "sample string 2",
"RecipientGroupName": "sample string 3",
"RecipientType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
},
"Id": 7
},
{
"Property": {
"Address": {
"OrganizationName": "sample string 1",
"Number": "sample string 2",
"BuildingName": "sample string 3",
"Street": "sample string 4",
"Town": "sample string 5",
"Locality": "sample string 6",
"County": "sample string 7",
"Postcode": "sample string 8",
"Id": 9
},
"Roles": [
{
"Id": 1,
"Name": "sample string 2",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"OwningBranch": {
"Id": 1,
"Name": "sample string 1"
}
},
{
"Id": 1,
"Name": "sample string 2",
"RoleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"RoleStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"OwningBranch": {
"Id": 1,
"Name": "sample string 1"
}
}
],
"Id": 1
},
"Name": "sample string 1",
"Code": "sample string 2",
"IsCheckedOut": true,
"IsPermanent": true,
"CheckedInAt": "2026-08-05T01:28:48.5753357Z",
"CheckedInBy": {
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"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 4",
"Id": 5
},
"NoteOnCheckIn": "sample string 5",
"CheckedOutAt": "2026-08-05T01:28:48.5753357Z",
"CheckedOutBy": {
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"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 4",
"Id": 5
},
"NoteOnCheckOut": "sample string 6",
"RecipientDetails": {
"RecipientId": 1,
"RecipientName": "sample string 2",
"RecipientGroupName": "sample string 3",
"RecipientType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
},
"Id": 7
}
]
}