Saltar al contenido

Get a recognition

Módulo Workforce

GET/recognitions/{id}recognitions.get

A shout-out from one member to another, tied to a project or shift and posted to the feed. No points currency. Returns one recognition with its `ETag`. A recognition the caller may not see returns 404.

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

Parámetros de ruta y de consulta

recognitions.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the recognition.
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: Recognition

recognitions.get: Recognition
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the recognition.
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íPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
from_membership_idstring (uuid)SíIdentifier of the member who gave the recognition.
to_membership_idstring (uuid)SíIdentifier of the member recognized.
project_idstring (uuid) | nullSíIdentifier of the project the recognition is for.
shift_idstring (uuid) | nullSíIdentifier of the shift the recognition is for.
messagestringSíWhat they did well.Restricciones: length 1 to 1000
feed_post_idstring (uuid) | nullSíIdentifier of the recognition post in the feed.
{
  "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",
  "from_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shift_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message": "Re-rigged the truss in record time.",
  "feed_post_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

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