Ferndesk

Usuarios

Listar usuarios del centro de ayuda

Devuelve los usuarios del centro de ayuda de su organización. Utilice el filtro de correo electrónico opcional para buscar un usuario específico antes de actualizar los atributos guardados.

GET /users

Listar usuarios del centro de ayuda

curl --request GET \
  --url 'https://api.ferndesk.com/v1/users' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "email": "<email>",
      "name": "<string>",
      "emailVerified": true,
      "disabled": true,
      "attributes": {},
      "lastLoginAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Usuarios del centro de ayuda paginados

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puede generar y administrar claves desde la página de Configuración de desarrolladores.

Query Parameters

  • email string (email)

    Filtro opcional de correo electrónico exacto. La coincidencia no distingue entre mayúsculas y minúsculas. Ejemplo: [email protected]

  • limit integer

    Número máximo de elementos a devolver (1-100). Ejemplo: 20

  • offset integer

    Número de elementos a omitir antes de recopilar los resultados. Ejemplo: 0

Response

application/json
  • items[] object array

    Elementos de la página actual. Carga útil del usuario del centro de ayuda.

    + Show Child Attributes
    • id string

      ID de usuario del centro de ayuda de Ferndesk (hcusr_...).

    • helpdeskId string

      ID de helpdesk de Ferndesk (help_...).

    • email string (email)

      Dirección de correo electrónico del usuario del centro de ayuda. Los correos electrónicos se almacenan en minúsculas.

    • name string | null

      Nombre visible para el usuario del centro de ayuda.

    • emailVerified boolean

      Indica si el correo electrónico ha sido verificado a través de un flujo de autenticación del centro de ayuda.

    • disabled boolean

      Indica si el usuario está deshabilitado. Los usuarios deshabilitados no pueden mantener sesiones activas.

    • attributes object

      Atributos de usuario guardados utilizados por las reglas de grupos de usuarios. Los valores pueden ser cadenas, números, booleanos o matrices de un tipo primitivo.

      + Show Child Attributes
      • [key: string] anyOf additional
        + Show Child Attributes
        • anyOf options 4 variants anyOf

          One or more options can apply.

          + Show Child Attributes
          • option 1 string | number | boolean
          • option 2 array
            + Show Child Attributes
            • items[] string array item
          • option 3 array
            + Show Child Attributes
            • items[] number array item
          • option 4 array
            + Show Child Attributes
            • items[] boolean array item
    • lastLoginAt string | null

      Marca de tiempo del inicio de sesión más reciente en el centro de ayuda, si existe.

    • createdAt string

      Marca de tiempo ISO 8601 en UTC.

    • updatedAt string

      Marca de tiempo ISO 8601 en UTC.

  • limit integer

    Tamaño de página utilizado para esta respuesta.

  • offset integer

    Número de registros omitidos para esta página.

  • total integer

    Total de registros coincidentes en todas las páginas.