Get a site plan pin
Places module
GET/site-plan-pins/{id}sitePlanPins.get
A pin on a site plan. Returns one site plan pin with its `ETag`. A site plan pin the caller may not see returns 404.
- Requires the capability places.venue.read.
- OAuth scopes: places.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the site plan pin. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: SitePlanPin
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the site plan pin. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| site_plan_id | string (uuid) | Yes | Identifier of the site plan. |
| label | string | Yes | Pin label.Constraints: length 1 to 300 |
| x | number | Yes | Horizontal position, 0 to 1. |
| y | number | Yes | Vertical position, 0 to 1. |
| zone_id | string (uuid) | null | Yes | Identifier of the zone the pin marks. |
| record_id | string (uuid) | null | Yes | Identifier of the record the pin marks. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"site_plan_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"label": "First Aid",
"x": 0.42,
"y": 0.71,
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/site-plan-pins/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.sitePlanPins.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.site_plan_pins.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos site-plan-pins get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f