Skip to content

Get a gate evidence

Projects module

GET/gate-evidence/{id}gateEvidence.get

Evidence for a gate criterion. One evidence spine serves every criterion. Returns one gate evidence with its `ETag`. A gate evidence the caller may not see returns 404.

  • Requires the capability projects.gate.read.
  • OAuth scopes: projects.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

gateEvidence.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the gate evidence.
fieldsFieldsNoSparse 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: GateEvidence

gateEvidence.get: GateEvidence
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the gate evidence.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)YesIdentifier of the project.
criterion_idCriterionIdYesGate criterion identifier from `xpms.dim_gate_criterion`.Constraints: pattern ^G[1-9]\.[A-Z0-9_]+$
record_idstring (uuid) | nullYesIdentifier of the record that evidences the criterion.
attested_bystring (uuid) | nullYesIdentifier of the person who attested the evidence.
attested_atstring (date-time)YesWhen the evidence was attested.
assertion_rankintegerYesAssertion rank of the evidence, 0 to 4.Constraints: range 0 to any
evidence_uristring | nullYesWhere the evidence lives: a document or record URI.Constraints: length 1 to 2000
notestring | nullYesNote on the evidence.Constraints: length 1 to 2000
{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "criterion_id": "G1.BUDGET_ENVELOPE",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "attested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "attested_at": "2026-10-08T14:30:00Z",
  "assertion_rank": 4,
  "evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "note": "Signed by the venue manager."
}

Code samples

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