> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/objects/property.md).

# The property object

The property object in the Shortcut API - every field, an example, and the endpoints that return it.

A property (service address) belonging to a customer.

## Fields

| Field                             | Type                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                       |
| --------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                              | id                   | The property's id.                                                                                                                                                                                                                                                                                                                                                                                                                |
| `object`                          | `"property"`         | Always `property`.                                                                                                                                                                                                                                                                                                                                                                                                                |
| `customerId`                      | id                   | The customer the property belongs to. Only in answers from `GET /v1/customers/{id}/properties`, `POST /v1/customers/{id}/properties`, `GET /v1/properties/{id}`, `PATCH /v1/properties/{id}`, `PUT /v1/properties/{id}/external-references/{source}`, `DELETE /v1/properties/{id}/external-references/{source}`, `GET /v1/properties/external/{source}/{externalId}`, `PUT /v1/properties/external/{source}/{externalId}`.        |
| `label`                           | string or null       | A short name for the property, such as `Home`.                                                                                                                                                                                                                                                                                                                                                                                    |
| `address`                         | string               | The full street address.                                                                                                                                                                                                                                                                                                                                                                                                          |
| `latitude`                        | number or null       | Latitude, when the address was located.                                                                                                                                                                                                                                                                                                                                                                                           |
| `longitude`                       | number or null       | Longitude, when the address was located.                                                                                                                                                                                                                                                                                                                                                                                          |
| `squareFeet`                      | number or null       | Measured lawn area in square feet.                                                                                                                                                                                                                                                                                                                                                                                                |
| `status`                          | `active`, `inactive` | Inactive properties are no longer serviced.                                                                                                                                                                                                                                                                                                                                                                                       |
| `externalReferences`              | array of objects     | Ids this property has in your other systems. Only in answers from `GET /v1/customers/{id}/properties`, `POST /v1/customers/{id}/properties`, `GET /v1/properties/{id}`, `PATCH /v1/properties/{id}`, `PUT /v1/properties/{id}/external-references/{source}`, `DELETE /v1/properties/{id}/external-references/{source}`, `GET /v1/properties/external/{source}/{externalId}`, `PUT /v1/properties/external/{source}/{externalId}`. |
| `externalReferences[].source`     | string               | The system the id comes from.                                                                                                                                                                                                                                                                                                                                                                                                     |
| `externalReferences[].externalId` | string               | The object's id in that system.                                                                                                                                                                                                                                                                                                                                                                                                   |
| `createdAt`                       | timestamp            | When the property was created, ISO 8601 in UTC.                                                                                                                                                                                                                                                                                                                                                                                   |
| `updatedAt`                       | timestamp            | When the property last changed, ISO 8601 in UTC.                                                                                                                                                                                                                                                                                                                                                                                  |

## Example

```json
{
  "id": "64d8bc60-6122-47a7-8d6d-32ee59b76e35",
  "object": "property",
  "customerId": "11469e64-0d90-49ab-89db-14f206255039",
  "label": "Home",
  "address": "412 Elm St, Bozeman, MT 59715",
  "latitude": 45.6793,
  "longitude": -111.0373,
  "squareFeet": 8200,
  "status": "active",
  "externalReferences": [
    {
      "source": "mywebsite",
      "externalId": "contact-58213"
    }
  ],
  "createdAt": "2026-10-16T17:04:12.381Z",
  "updatedAt": "2026-10-16T17:04:12.381Z"
}
```

## Endpoints

| Endpoint                                                  | What it does                           |
| --------------------------------------------------------- | -------------------------------------- |
| `GET /v1/customers/{id}/properties`                       | List a customer's properties           |
| `POST /v1/customers/{id}/properties`                      | Add a property                         |
| `GET /v1/properties/{id}`                                 | Get a property                         |
| `PATCH /v1/properties/{id}`                               | Update a property                      |
| `PUT /v1/properties/{id}/external-references/{source}`    | Link a property to your id             |
| `DELETE /v1/properties/{id}/external-references/{source}` | Unlink a property from your id         |
| `GET /v1/properties/external/{source}/{externalId}`       | Get a property by your id              |
| `PUT /v1/properties/external/{source}/{externalId}`       | Create or update a property by your id |