Get an access grid entry
Credentials module
GET/access-grid/{id}accessGridEntries.get
A zone by credential category access rule with a time window. Returns one access grid entry with its `ETag`. A access grid entry the caller may not see returns 404.
- Requires the capability credentials.credential.read.
- OAuth scopes: credentials.
- 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 access grid entry. |
| 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: AccessGridEntry
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the access grid entry. |
| 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. |
| zone_id | string (uuid) | Yes | Identifier of the zone. |
| credential_category_id | string (uuid) | Yes | Identifier of the credential category. |
| access_level_enum_id | string | Yes | Access level: a row of the canon Access Level enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| window_starts_at | string (date-time) | Yes | When access opens. |
| window_ends_at | string (date-time) | Yes | When access closes. |
| project_id | string (uuid) | Yes | Identifier of the project of the category, copied from it. |
{
"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",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"credential_category_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"access_level_enum_id": "ENM-036",
"window_starts_at": "2026-10-08T14:30:00Z",
"window_ends_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X GET "$XOS_BASE_URL/access-grid/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.accessGridEntries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.access_grid_entries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos access-grid-entries get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f