Skip to content

Get property

Request

Retrieve a property by its id. Returns 404 if the property does not exist or belongs to another organization.

Security
bearer-token
Path
idstringrequired

Id of the property.

Headers
Checkr-Tenant-Versionstring

CalVer-dated API version to pin behavior to (e.g. 2026-04-29). When omitted, the request is served by the newest supported version. Unknown values return 422.

Value:"2026-04-29"
GET
/properties/{id}
curl -i -X GET \
  'https://tenant.checkr.com/api/properties/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Checkr-Tenant-Version: 2026-04-29'

Responses

OK

Bodyapplication/json
idstring

Unique identifier for the property record. Use this value in subsequent API calls; it is stable for the lifetime of the property. Test-mode IDs carry a _test_ infix (e.g. pr_test_K9dM2pXqR4vN8tLZbWyHJa); live-mode IDs have no infix.

Example:"pr_K9dM2pXqR4vN8tLZbWyHJa"
namestring or null

Optional human-readable label for the property (e.g. a building or unit nickname). When set, it is shown to applicants and used in email/SMS communications in addition to the property address.

Example:"Sunset Apartments"
streetstring

Street line of the property address (number and street name).

Example:"1234 Market St"
unitstring or null

Optional unit, suite, or apartment designator within the building.

Example:"Apt 4B"
citystring

City the property is located in.

Example:"San Francisco"
statestring

Two-letter USPS state or territory code (uppercase).

Example:"CA"
zipcodestring

5-digit US ZIP code or ZIP+4.

Example:"94103"
created_atstring, (date-time)

Timestamp the property record was created.

Response
{
  "id": "pr_K9dM2pXqR4vN8tLZbWyHJa",
  "name": "Sunset Apartments",
  "street": "1234 Market St",
  "unit": "Apt 4B",
  "city": "San Francisco",
  "state": "CA",
  "zipcode": "94103",
  "created_at": "2019-08-24T14:15:22Z"
}