GET api/property/{id}/keys

Get a list of keys for a property Processes this property 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 Id of the property	integer	Required

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

Collection of PropertyKeyDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Code	The code value.	string	None.
IsCheckedOut	Indicates whether this item is checked out.	boolean	None.
IsPermanent	Indicates whether this item is permanent.	boolean	None.
CheckedInAt	The checked in at, expressed as a date and time.	date	None.
CheckedInBy	The checked in by value.	KeyNegotiatorDataContract	None.
NoteOnCheckIn	The note on check in value.	string	None.
CheckedOutAt	The checked out at, expressed as a date and time.	date	None.
CheckedOutBy	The checked out by value.	KeyNegotiatorDataContract	None.
NoteOnCheckOut	The note on check out value.	string	None.
RecipientDetails	The recipient details value.	KeyRecipientDetailsDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Code": "sample string 2",
    "IsCheckedOut": true,
    "IsPermanent": true,
    "CheckedInAt": "2026-07-21T15:19:50.9648938Z",
    "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-07-21T15:19:50.9648938Z",
    "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
  },
  {
    "Name": "sample string 1",
    "Code": "sample string 2",
    "IsCheckedOut": true,
    "IsPermanent": true,
    "CheckedInAt": "2026-07-21T15:19:50.9648938Z",
    "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-07-21T15:19:50.9648938Z",
    "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
  }
]