Listar usuarios

Lista los miembros de tu empresa (las personas a las que se pueden asignar tareas), ordenados por nombre, con su id, nombre, email, iniciales y color de avatar.

q filtra por nombre o email.
Con paginación por cursor: pasa el next_cursor de una página como starting_after para obtener la siguiente; has_more indica si hay más.

Parámetros de consulta

q?|

Texto que se compara con el nombre o el email del miembro, sin distinguir mayúsculas ni acentos. Máximo 120 caracteres.

Longitudlength <= 120

limit?integer

Número de usuarios a devolver. Entero entre 1 y 100. Por defecto 25.

Rango1 <= value <= 100

starting_after?string

Cursor de paginación hacia delante: el id del último usuario de la página anterior (el next_cursor que recibiste). Un id que no está en esta lista devuelve 422 invalid_param_value.

Formatouuid

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate

X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la respuesta

`application/json`

Ejemplo de petición

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/users?limit=25", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Ejemplo de respuesta

{
  "data": [
    {
      "id": "0193a4f2-6b1c-7d3e-8a41-2c5e7f9a1b01",
      "object": "user",
      "name": "Ana Pérez",
      "email": "ana.perez@example.com",
      "initials": "AP",
      "avatar_color": "pink"
    },
    {
      "id": "0193a4f2-6b1c-7d3e-8a41-2c5e7f9a1b02",
      "object": "user",
      "name": "Javier Gómez",
      "email": "javier.gomez@example.com",
      "initials": "JG",
      "avatar_color": "amber"
    }
  ],
  "has_more": true,
  "next_cursor": "0193a4f2-6b1c-7d3e-8a41-2c5e7f9a1b02"
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_3398f3f62a340c455ee377a7d4"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'users:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_2923bd71aa52d7ccad327a74cd"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El parámetro 'starting_after' debe ser un UUID válido del recurso.",
    "param": "starting_after",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_7fafbd5502609c15dfe6927e58"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_32f41d8c80e8c47f9b2088a0e5"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_333750271c194283a9c001bcdb"
  }
}

Listar usuarios

Authorization

Parámetros de consulta

Headers

Cuerpo de la respuesta

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`