Get a venue
Módulo Places
GET/venues/{id}venues.get
A venue. Returns one venue with its `ETag`. A venue the caller may not see returns 404.
- Requiere la capacidad places.venue.read.
- Alcances de OAuth: places.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the venue. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: Venue
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the venue. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Sí | Venue name.Restricciones: length 1 to 300 |
| street_address | string | null | Sí | Street address.Restricciones: length 1 to 300 |
| locality | string | null | Sí | City.Restricciones: length 1 to 300 |
| postal_code | string | null | Sí | Postal code.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| jurisdiction_id | JurisdictionId | Sí | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| time_zone | string | Sí | IANA time zone the local time was entered in.Restricciones: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| latitude | number | null | Sí | WGS 84 latitude.Restricciones: range -90 to 90 |
| longitude | number | null | Sí | WGS 84 longitude.Restricciones: range -180 to 180 |
{
"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",
"name": "Harborfront Lawn",
"street_address": "100 Harbor Way",
"locality": "Miami",
"postal_code": "33132",
"jurisdiction_id": "US-FL",
"time_zone": "America/New_York",
"latitude": 25.7617,
"longitude": -80.1918
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/venues/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.venues.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.venues.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos venues get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f