Saltar al contenido

Get a help desk team member

Módulo Workforce

GET/help-desk-team-members/{id}helpDeskTeamMembers.get

A member who answers a help desk team's requests. Deleting removes them. Returns one help desk team member with its `ETag`. A help desk team member the caller may not see returns 404.

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

Parámetros de ruta y de consulta

helpDeskTeamMembers.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the help desk team member.
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: HelpDeskTeamMember

helpDeskTeamMembers.get: HelpDeskTeamMember
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the help desk team member.
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.
help_desk_team_idstring (uuid)SíIdentifier of the team.
membership_idstring (uuid)SíIdentifier of the member.
{
  "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",
  "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

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