Listar todos los tipos de ausencia

Lista los tipos de ausencia de tu empresa con paginación por cursor.

Admite filtrar por status (active/archived) y measurement_unit (days/hours), más una search de texto libre sobre el nombre del tipo.

Parámetros de consulta

limit?integer

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

Predeterminado25

Rango1 <= value <= 100

starting_after?string

Cursor para paginación hacia delante. Usa el uuid del último objeto de la página anterior.

Formatouuid

ending_before?string

Cursor para paginación hacia atrás. Usa el uuid del primer objeto de la página actual.

Formatouuid

status?string

Estado del ciclo de vida del tipo de ausencia. Coincidencia exacta con status.

Valor en"active" | "archived"

status[in]?string

Estado del ciclo de vida del tipo de ausencia. Lista separada por comas. Coincide cualquiera de los valores.

measurement_unit?string

Unidad de medida usada para cuantificar el tipo de ausencia. Coincidencia exacta con measurement_unit.

Valor en"days" | "hours"

measurement_unit[in]?string

Unidad de medida usada para cuantificar el tipo de ausencia. Lista separada por comas. Coincide cualquiera de los valores.

search?string

Búsqueda de texto libre. LIKE %term% escapado (sin distinguir mayúsculas, máx. 80 caracteres) sobre las columnas de texto clave del recurso, combinado con los demás filtros (AND) y compatible con el cursor.

Longitudlength <= 80

Headers

Factuarea-Version?string

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/absence-types?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": "01933a30-c065-7f71-9d8e-5e6f7a8b9c01",
      "object": "absence_type",
      "name": "Vacaciones",
      "is_paid": true,
      "requires_approval": true,
      "measurement_unit": "days",
      "color": "#2563EB",
      "visibility": "everyone",
      "is_system": true,
      "status": "active",
      "created_at": "2024-09-01T10:00:00Z",
      "updated_at": "2024-09-01T10:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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

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

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "Los parámetros 'starting_after' y 'ending_before' son mutuamente excluyentes.",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_d2021a33c962e2c855748d1089"
  }
}

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

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

Listar todos los tipos de ausencia

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`