Work Schedules

Retrieve a work schedule

Retrieve a single work schedule by its id (UUID v7). A schedule belonging to another company returns 404 work_schedule_not_found (anti-enumeration).

get/companies/{company}/work-schedules/{schedule}

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/work-schedules/{schedule}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

schedulestring uuid required

Public identifier (UUID v7) of the work schedule.

Headers

Factuarea-Versionstring date
Example:2026-06-01

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.

Response

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.