> 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-access.md).

# The property access object

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

How crews get into a property. Read with `access:read`, which no preset but AI agent holds.

## Fields

| Field          | Type                | Description                                         |
| -------------- | ------------------- | --------------------------------------------------- |
| `propertyId`   | id                  | The property's id.                                  |
| `object`       | `"property_access"` | Always `property_access`.                           |
| `code`         | string or null      | The gate, door, or lockbox code crews use.          |
| `instructions` | string or null      | How crews get in: where the gate is, dogs, parking. |

## Example

```json
{
  "propertyId": "bbc128ea-b80b-4431-8455-9f78b09fdabf",
  "object": "property_access",
  "code": "Example code",
  "instructions": "Example instructions"
}
```

## Endpoints

| Endpoint                         | What it does                    |
| -------------------------------- | ------------------------------- |
| `GET /v1/properties/{id}/access` | Get a property's access details |
| `PUT /v1/properties/{id}/access` | Set a property's access details |
