Factuarea API
Empleats

Llistar tots els empleats

Llista els empleats de la teva empresa amb paginació per cursor. Admet filtrar per status (active/inactive), employment_type (full_time/part_time) i ccaa, més una search de text lliure sobre nom i email.

GET
/employees

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de consulta

limit?integer

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

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.

Formatuuid
ending_before?string

Cursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.

Formatuuid
status?string

Estat de l'empleat. Coincidència exacta amb status.

Valor a"active" | "inactive"
status[in]?string

Estat de l'empleat. Llista separada per comes. Coincideix qualsevol dels valors.

employment_type?string

Tipus de contracte laboral. Coincidència exacta amb employment_type.

Valor a"full_time" | "part_time"
employment_type[in]?string

Tipus de contracte laboral. Llista separada per comes. Coincideix qualsevol dels valors.

ccaa?string

Codi de comunitat autònoma espanyola (ISO 3166-2:ES) de l'empleat. Coincidència exacta amb ccaa.

ccaa[in]?string

Codi de comunitat autònoma espanyola (ISO 3166-2:ES) de l'empleat. Llista separada per comes. Coincideix qualsevol dels valors.

search?string

Cerca de text lliure. LIKE %term% escapat (sense distingir majúscules, màx. 80 caràcters) sobre les columnes de text clau del recurs, combinat amb la resta de filtres (AND) i compatible amb el cursor.

Longitudlength <= 80

Paràmetres de capçalera

Factuarea-Version?string

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

application/json

application/json

application/json

application/json

application/json

import { Factuarea } from "@factuarea/sdk";const factuarea = new Factuarea({ apiKey: process.env.FACTUAREA_API_KEY! });// List endpoints return an async-iterable Page (cursors handled for you).for await (const item of await factuarea.employees.list({ limit: 25 })) {  console.log(item.id);}
{
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c",
  "data": [
    {
      "id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
      "object": "employee",
      "first_name": "Lucía",
      "last_name": "Fernández Ruiz",
      "email": "lucia.fernandez@empresa.com",
      "tax_id": "12345678Z",
      "job_title": "Desarrolladora backend",
      "employment_type": "full_time",
      "contract_hours": 40,
      "hire_date": "2024-09-02",
      "termination_date": null,
      "ccaa": "MD",
      "status": "active",
      "external_id": "EMP-1042",
      "metadata": {
        "erp_code": "IVA-GEN",
        "ledger_account": "477000"
      },
      "user_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e02",
      "created_at": "2024-09-02T08:00:00Z",
      "updated_at": "2026-05-04T09:03:01Z"
    }
  ]
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}
POST

Cercar un empleat per external ID

POST

Reactivar un empleat