Factuarea API
Horaris de treball

Llistar tots els horaris de treball

Llista els horaris de treball setmanals de la teva empresa amb paginació per cursor. Admet filtrar per status (active/archived) i mode (validated/real_clocking), més una search de text lliure sobre el nom de l'horari.

GET
/work-schedules

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 del cicle de vida de l'horari de treball. Coincidència exacta amb status.

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

Estat del cicle de vida de l'horari de treball. Llista separada per comes. Coincideix qualsevol dels valors.

mode?string

Mode de control horari de l'horari de treball. Coincidència exacta amb mode.

Valor a"validated" | "real_clocking"
mode[in]?string

Mode de control horari de l'horari de treball. 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.workSchedules.list({ limit: 25 })) {  console.log(item.id);}
{
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c",
  "data": [
    {
      "id": "01933a20-9d32-7c4e-8a5b-2b3c4d5e6f01",
      "object": "work_schedule",
      "name": "Jornada partida",
      "mode": "validated",
      "week_pattern": [
        {
          "day": 1,
          "ranges": [
            {
              "start": "09:00",
              "end": "14:00"
            },
            {
              "start": "15:00",
              "end": "18:00"
            }
          ]
        },
        {
          "day": 5,
          "ranges": [
            {
              "start": "08:00",
              "end": "15:00"
            }
          ]
        }
      ],
      "weekly_hours": 40,
      "status": "active",
      "created_at": "2024-09-01T10:00:00Z",
      "updated_at": "2024-09-01T10:00:00Z"
    }
  ]
}

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

Obtenir l'horari actual d'un empleat

GET

Obtenir un horari de treball