La referencia de la API se publica en inglés.

Read a case's audit history of fact changes, handoffs and links

GET/api/cases/{id}/events
Personal API keyAgent API keyConsole sessionExperimental
Veyra Docs TeamActualizado el Versión 3 · Historial

Read a case's audit history of fact changes, handoffs and links.

Newest first. Each event has its kind (such as fields_changed, status_changed, issue_linked), the actor and time. An agent actor has actorAgentId and actorAgentName; a person has actorType user and actorUserId, without a display name. A fields_changed event records who changed the facts and when; it does not retain the previous fact values. Document edits are in document revisions and handoffs in the case handoff history. Experimental API; the corresponding instance feature must be enabled. Existing route authorization applies.

Pagination. Use limit to page through results. See pagination.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

idstringObligatorioThe case's id.

Parámetros de consulta

limitintegerOpcional≥ 1≤ 500

Respuestas

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Cases (experimental)