Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Properties

Service addresses that belong to customers.

A property is a customer's service address: where the work happens, with its label, coordinates, and measured lawn area.

Fields: The property object · The property access object.

List a customer's properties

get

The customer's properties (service addresses), newest first, or by last change when updatedSince is set.

Returns a list of property objects.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

Query parameters
limitinteger · min: 1 · max: 200Optional

How many items to return, 1-200. Defaults to 50.

Default: 50
cursorstring · min: 1 · max: 4096Optional

The meta.nextCursor from the previous page. Omit it for the first page.

updatedSincestring · date-timeOptional

ISO 8601 timestamp. Returns objects changed at or after it, oldest change first. Keep the largest updatedAt you have seen, subtract five minutes, and pass it on the next sync; deduplicate by id.

Responses
200

Success.

application/json
get/v1/customers/{id}/properties
curl https://api.shortcutco.com/v1/customers/03828fe2-ffcc-4b29-8c17-0670f86141b7/properties \
  -H "Authorization: Bearer $SHORTCUT_TOKEN"
{
  "data": [
    {
      "id": "0893e25d-04de-4da4-8128-58ebfd729432",
      "object": "property",
      "customerId": "03828fe2-ffcc-4b29-8c17-0670f86141b7",
      "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"
    }
  ],
  "meta": {
    "nextCursor": null,
    "hasMore": false
  }
}

Add a property

post

Adds a property (service address) to a customer, as adding one on their profile does. Send latitude and longitude together when you have them; the map and routes use them. With externalReference, your id is saved in the same request, and a duplicate fails it with 409. The property gets its own customer-stage lead record, as in the app; if the token has automations:trigger, automations that start when a lead is created run as they do for properties added in the app. Send an Idempotency-Key to retry safely.

Returns the property object.

Errors specific to this endpoint: already_exists. Every endpoint can also return the common errors.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

Header parameters
Idempotency-Keystring · max: 255Optional

Any string up to 255 characters. Retrying with the same key returns the first response instead of repeating the write, for 24 hours.

Body

A new property for the customer.

addressstring · min: 1 · max: 300Required

The service address on one line, such as 412 Elm St, Bozeman, MT 59715.

labelstring · max: 120Optional

A short name for the property, such as Home.

latitudenumber · min: -90 · max: 90Optional

Latitude of the address. Send with longitude.

longitudenumber · min: -180 · max: 180Optional

Longitude of the address. Send with latitude.

squareFeetnumber · max: 100000000Optional

Lawn area in square feet.

Responses
201

Success.

application/json
post/v1/customers/{id}/properties
curl https://api.shortcutco.com/v1/customers/03828fe2-ffcc-4b29-8c17-0670f86141b7/properties \
  -X POST \
  -H "Authorization: Bearer $SHORTCUT_TOKEN" \
  -H "Idempotency-Key: aedeb974-ab28-44bb-8773-3002a3bd6b49" \
  -H "Content-Type: application/json" \
  -d '{"address":"412 Elm St, Bozeman, MT 59715"}'
{
  "data": {
    "id": "2e1bde19-2a66-4960-86b0-54a722fa8fee",
    "object": "property",
    "customerId": "03828fe2-ffcc-4b29-8c17-0670f86141b7",
    "label": null,
    "address": "412 Elm St, Bozeman, MT 59715",
    "latitude": null,
    "longitude": null,
    "squareFeet": null,
    "status": "active",
    "externalReferences": [],
    "createdAt": "2026-10-16T17:04:12.381Z",
    "updatedAt": "2026-10-16T17:04:12.381Z"
  }
}

Get a property

get

One property (service address). Gate codes and access notes are not included.

Returns the property object.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

Responses
200

Success.

application/json
get/v1/properties/{id}
curl https://api.shortcutco.com/v1/properties/8fb2e444-8bfd-4f8b-8847-5ad284919619 \
  -H "Authorization: Bearer $SHORTCUT_TOKEN"
{
  "data": {
    "id": "8fb2e444-8bfd-4f8b-8847-5ad284919619",
    "object": "property",
    "customerId": "239baccf-1fe5-4816-8c30-235d187a5ea4",
    "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"
  }
}

Update a property

patch

Changes a property's address, label, or square footage, as editing it in the app does. A new address needs its latitude and longitude. Moving the address to another spot clears the property's map, its measured areas, and a square footage taken from that map: the request is refused with 409 property_map_would_clear unless it sends confirmClearPropertyMap: true, and meta.effects lists what was cleared. Fields you leave out are unchanged.

Returns the property object.

Errors specific to this endpoint: property_map_would_clear. Every endpoint can also return the common errors.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

Body

The fields to change. Fields you leave out are unchanged.

addressstring · min: 1 · max: 300Optional

A new address. Send latitude and longitude with it so the map and routes stay right. Moving it to another spot clears the property's map; see confirmClearPropertyMap.

labelstring · max: 120 · nullableOptional

A short name for the property. Null or empty clears it.

latitudenumber · min: -90 · max: 90Optional

Latitude of the address. Send with longitude.

longitudenumber · min: -180 · max: 180Optional

Longitude of the address. Send with latitude.

squareFeetnumber · max: 100000000 · nullableOptional

Lawn area in square feet. Null clears it.

confirmClearPropertyMapbooleanOptional

Set true to allow an address change that clears the property's map, measurements, or measured square footage. Without it such a change is refused with property_map_would_clear and nothing changes.

Responses
200

Success.

application/json
patch/v1/properties/{id}
curl https://api.shortcutco.com/v1/properties/8fb2e444-8bfd-4f8b-8847-5ad284919619 \
  -X PATCH \
  -H "Authorization: Bearer $SHORTCUT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"address":"412 Elm St, Bozeman, MT 59715"}'
{
  "data": {
    "id": "8fb2e444-8bfd-4f8b-8847-5ad284919619",
    "object": "property",
    "customerId": "f03e76a1-ec88-41e8-88d2-ed2fe51d2876",
    "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"
  }
}

Get a property's access details

get

The gate or lockbox code and the access instructions crews use at the property. Needs access:read, an opt-in scope: no preset but AI agent holds it, and the property object never carries these.

Returns the property access object.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

Responses
200

Success.

application/json
get/v1/properties/{id}/access
curl https://api.shortcutco.com/v1/properties/7c4736b1-7891-41f8-84db-ad3f7125e886/access \
  -H "Authorization: Bearer $SHORTCUT_TOKEN"
{
  "data": {
    "propertyId": "7c4736b1-7891-41f8-84db-ad3f7125e886",
    "object": "property_access",
    "code": "Example code",
    "instructions": "Example instructions"
  }
}

Set a property's access details

put

Sets the gate or lockbox code or the access instructions crews see on the property's visits. Fields left out stay as they are; null clears one. Needs access:write, an opt-in scope.

Returns the property access object.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

Header parameters
Idempotency-Keystring · max: 255Optional

Any string up to 255 characters. Retrying with the same key returns the first response instead of repeating the write, for 24 hours.

Body

The fields to change; send at least one.

codestring · max: 120 · nullableOptional

The gate or lockbox code, up to 120 characters; null clears it.

instructionsstring · max: 2000 · nullableOptional

Access instructions for crews; null clears them.

Responses
200

Success.

application/json
put/v1/properties/{id}/access
curl https://api.shortcutco.com/v1/properties/7c4736b1-7891-41f8-84db-ad3f7125e886/access \
  -X PUT \
  -H "Authorization: Bearer $SHORTCUT_TOKEN" \
  -H "Idempotency-Key: af0c8e6e-ab56-49b5-87a1-04fca3eb4043" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "data": {
    "propertyId": "7c4736b1-7891-41f8-84db-ad3f7125e886",
    "object": "property_access",
    "code": "Example code",
    "instructions": "Example instructions"
  }
}

Link a property to your id

put

Records externalId as this property's id in source, so the external lookup and upsert find it. Linking is always explicit; the API never matches a property to your id by address. Repeating the same link changes nothing. If the id already belongs to another property, or this property already has a different id in source, the request fails with 409 and nothing changes.

Returns the property object.

Errors specific to this endpoint: already_exists, external_reference_exists. Every endpoint can also return the common errors.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

sourcestringRequired

Your name for the system the id comes from, such as hubspot or mywebsite: 1-64 lowercase letters, digits, _, ., or -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_.-]{0,63}$
Header parameters
Idempotency-Keystring · max: 255Optional

Any string up to 255 characters. Retrying with the same key returns the first response instead of repeating the write, for 24 hours.

Body

The object's id in that system.

externalIdstring · min: 1 · max: 255Required

The object's id in that system: 1-255 characters, no spaces, slashes, or control characters.

Pattern: ^[^\p{Cc}\s/\\]+$
Responses
200

Success.

application/json
put/v1/properties/{id}/external-references/{source}
curl https://api.shortcutco.com/v1/properties/de4e0add-da98-4624-86e2-816bd32cbcb2/external-references/mywebsite \
  -X PUT \
  -H "Authorization: Bearer $SHORTCUT_TOKEN" \
  -H "Idempotency-Key: b97791a2-b5c1-4ce9-820c-0830ae564377" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"contact-58213"}'
{
  "data": {
    "id": "de4e0add-da98-4624-86e2-816bd32cbcb2",
    "object": "property",
    "customerId": "c16e8da3-bdb8-48ea-8a03-0431b64d3f78",
    "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"
  }
}

Unlink a property from your id

delete

Removes this property's id in source. The property itself is unchanged. Unlinking when there is no link changes nothing.

Returns the property object.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
idstring · uuidRequired

The object's id.

sourcestringRequired

Your name for the system the id comes from, such as hubspot or mywebsite: 1-64 lowercase letters, digits, _, ., or -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_.-]{0,63}$
Responses
200

Success.

application/json
delete/v1/properties/{id}/external-references/{source}
curl https://api.shortcutco.com/v1/properties/de4e0add-da98-4624-86e2-816bd32cbcb2/external-references/mywebsite \
  -X DELETE \
  -H "Authorization: Bearer $SHORTCUT_TOKEN"
{
  "data": {
    "id": "de4e0add-da98-4624-86e2-816bd32cbcb2",
    "object": "property",
    "customerId": "e1f9dc3f-de44-4786-8a8e-52cdd6d88e14",
    "label": "Home",
    "address": "412 Elm St, Bozeman, MT 59715",
    "latitude": 45.6793,
    "longitude": -111.0373,
    "squareFeet": 8200,
    "status": "active",
    "externalReferences": [],
    "createdAt": "2026-10-16T17:04:12.381Z",
    "updatedAt": "2026-10-16T17:04:12.381Z"
  }
}

Get a property by your id

get

The property your id maps to, as GET /v1/properties/{id} returns it, or 404.

Returns the property object.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
sourcestringRequired

Your name for the system the id comes from, such as hubspot or mywebsite: 1-64 lowercase letters, digits, _, ., or -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_.-]{0,63}$
externalIdstring · min: 1 · max: 255Required

The object's id in that system: 1-255 characters, no spaces, slashes, or control characters.

Pattern: ^[^\p{Cc}\s/\\]+$
Responses
200

Success.

application/json
get/v1/properties/external/{source}/{externalId}
curl https://api.shortcutco.com/v1/properties/external/mywebsite/contact-58213 \
  -H "Authorization: Bearer $SHORTCUT_TOKEN"
{
  "data": {
    "id": "40b41272-3cfe-4db9-8948-89003592c447",
    "object": "property",
    "customerId": "66e0cef6-632b-4a3d-8f75-45845bbf80cb",
    "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"
  }
}

Create or update a property by your id

put

The sync endpoint for properties. If your id is new, adds the property to customerId as POST /v1/customers/{id}/properties does and saves the id (created: true, status 201). If it exists, applies the fields that differ to that property as PATCH does (created: false, status 200); an unchanged address string is unchanged whatever coordinates come with it, and a request that changes nothing writes nothing. The property must belong to customerId, or the request fails with 409. A move to another spot needs confirmClearPropertyMap: true, as in PATCH. Concurrent requests for the same id run one after another.

Errors specific to this endpoint: external_reference_changed, external_reference_customer_mismatch, property_map_would_clear. Every endpoint can also return the common errors.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

A workspace API token. Each operation lists the scopes it needs; write implies read, and send/complete are never implied.

Path parameters
sourcestringRequired

Your name for the system the id comes from, such as hubspot or mywebsite: 1-64 lowercase letters, digits, _, ., or -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_.-]{0,63}$
externalIdstring · min: 1 · max: 255Required

The object's id in that system: 1-255 characters, no spaces, slashes, or control characters.

Pattern: ^[^\p{Cc}\s/\\]+$
Header parameters
Idempotency-Keystring · max: 255Optional

Any string up to 255 characters. Retrying with the same key returns the first response instead of repeating the write, for 24 hours.

Body

The property as in POST /v1/customers/{id}/properties, plus its customer. When the reference is new the property is created; when it exists, these fields update the mapped property.

customerIdstring · uuidRequired

The customer the property belongs to. When the reference exists it must be this customer.

addressstring · min: 1 · max: 300Required

The service address on one line, such as 412 Elm St, Bozeman, MT 59715.

labelstring · max: 120Optional

A short name for the property, such as Home.

latitudenumber · min: -90 · max: 90Optional

Latitude of the address. Send with longitude.

longitudenumber · min: -180 · max: 180Optional

Longitude of the address. Send with latitude.

squareFeetnumber · max: 100000000Optional

Lawn area in square feet.

confirmClearPropertyMapbooleanOptional

Set true to allow an address change that clears the property's map, measurements, or measured square footage. Without it such a change is refused with property_map_would_clear and nothing changes.

Responses
200

Success.

application/json
put/v1/properties/external/{source}/{externalId}
curl https://api.shortcutco.com/v1/properties/external/mywebsite/contact-58213 \
  -X PUT \
  -H "Authorization: Bearer $SHORTCUT_TOKEN" \
  -H "Idempotency-Key: 30bb1064-2d05-4bab-894f-86f22599c239" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"8a889f58-86d2-4a9f-831d-15e67f67512d","address":"412 Elm St, Bozeman, MT 59715"}'
{
  "data": {
    "created": false,
    "property": {
      "id": "f8a55d0a-f4ef-4851-8139-d398ed840edf",
      "object": "property",
      "customerId": "8a889f58-86d2-4a9f-831d-15e67f67512d",
      "label": null,
      "address": "412 Elm St, Bozeman, MT 59715",
      "latitude": null,
      "longitude": null,
      "squareFeet": null,
      "status": "active",
      "externalReferences": [
        {
          "source": "mywebsite",
          "externalId": "contact-58213"
        }
      ],
      "createdAt": "2026-10-16T17:04:12.381Z",
      "updatedAt": "2026-10-16T17:04:12.381Z"
    }
  }
}

Last updated