Llistar usuaris

Llista els membres de la teva empresa (les persones a qui es poden assignar tasques), ordenats per nom, amb el seu id, nom, email, inicials i color d'avatar.

q filtra per nom o email.
Amb paginació per cursor: passa el next_cursor d'una pàgina com a starting_after per obtenir la següent; has_more indica si n'hi ha més.

Paràmetres de consulta

q?|

Text que es compara amb el nom o l'email del membre, sense distingir majúscules ni accents. Màxim 120 caràcters.

Longitudlength <= 120

limit?integer

Nombre d'usuaris a retornar. Enter entre 1 i 100. Per defecte 25.

Rang1 <= value <= 100

starting_after?string

Cursor de paginació cap endavant: l'id de l'últim usuari de la pàgina anterior (el next_cursor que vas rebre). Un id que no és en aquesta llista retorna 422 invalid_param_value.

Formatuuid

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

`application/json`

Exemple de petició

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());

Exemple de resposta

{
  "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"
  }
}

Llistar usuaris

Authorization

Paràmetres de consulta

Headers

Cos de la resposta

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`