List users

List the members of your company (the people tasks can be assigned to), ordered by name, with their id, name, email, initials and avatar color.

q filters by name or email.
Cursor-paginated: pass the next_cursor of a page as starting_after to get the next one; has_more tells whether there are more.

Query Parameters

q?|

Text matched against the member name or email, ignoring case and accents. Maximum 120 characters.

Lengthlength <= 120

limit?integer

Number of users to return. Integer between 1 and 100. Defaults to 25.

Range1 <= value <= 100

starting_after?string

Cursor for forward pagination: the id of the last user of the previous page (the next_cursor you received). An id that is not in this list returns 422 invalid_param_value.

Formatuuid

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

`application/json`

Request example

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

Response example

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

List users

Authorization

Query Parameters

Headers

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`