Saltar al contenido

Get an access scan

Módulo Credentials

GET/access-scans/{id}accessScans.get

A credential scan at an access point, validated against the Access Grid. Returns one access scan with its `ETag`. A access scan the caller may not see returns 404.

  • Requiere la capacidad credentials.scan_log.read.
  • Alcances de OAuth: credentials.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

accessScans.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the access scan.
fieldsFieldsNoSparse 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: AccessScan

accessScans.get: AccessScan
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the access scan.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
zone_idstring (uuid)SíIdentifier of the zone.
credential_idstring (uuid)SíIdentifier of the credential.
scanned_atstring (date-time)SíWhen the scan happened.
result"Granted" | "Denied"SíThe database's decision for the scan.
project_idstring (uuid)SíIdentifier of the project of the credential, copied from it.
device_scanned_atstring (date-time) | nullSíWhen the device scanned, for a scan made offline.
offline_result"Granted" | "Denied" | nullSíWhat the device decided offline.
{
  "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_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scanned_at": "2026-10-08T14:30:00Z",
  "result": "Granted",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "device_scanned_at": "2026-10-08T14:30:00Z",
  "offline_result": "Granted"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/access-scans/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.accessScans.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.access_scans.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos access-scans get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f