ReportsReport types and columns

Breaks

One row per break: type, start, end, paid or not.

GET /api/v1/reports/breaks?activity=AC-0001&week=2026-W47

43 columns

Ask for columns with fields, in the order you want. Without fields you get the ones marked Default.

  • activity_code
    Activity codeDefault
  • break_id
    Break IDDefault
  • agent_id
    Agent IDDefault
  • agent_code
    Agent codeDefault
  • date
    DateDefault
  • break_type
    Break typeDefault
  • break_start
    Break startDefault
  • break_end
    Break endDefault
  • break_duration
    Break lengthDefault
  • break_is_paid
    Paid breakDefault
  • agent_name
    AgentPersonal
  • agent_email
    EmailPersonal
  • agent_phone
    PhonePersonal
  • agent_country
    Country
  • agent_status
    Agent status
  • agent_timezone
    Agent timezone
  • supervisors
    SupervisorsPersonal

    The team in force on the row's day, or during its week or period

  • contract_type
    Contract
  • contract_weekly
    Contract hours / week
  • contract_start
    Contract start
  • contract_end
    Contract end
  • contract_max_daily
    Max hours / day
  • contract_max_days
    Max days / week
  • contract_vacation_days
    Vacation days / year
  • weekday
    Weekday
  • iso_week
    Week
  • month
    Month
  • shift_start
    Shift start
  • shift_end
    Shift end
  • break_notes
    Note
  • client_name
    Client
  • activity_name
    Activity
  • planning_title
    Planning

    The plannings the row's shifts come from

  • planning_label
    Planning label

    Client - Activity - S43 - 2026, the same for every activity, for rows inside one week

  • source
    Source
  • contract_id
    Contract ID
  • contract_type_id
    Contract type ID
  • client_code
    Client code
  • client_id
    Client ID
  • activity_id
    Activity ID
  • planning_id
    Planning ID
  • supervisor_ids
    Supervisor IDs

    IDs of the same supervisors, as in the Supervision page address

  • shift_id
    Shift ID

Custom fields

Your workspace's custom fields are columns too: cf.<key> for agent fields and ccf.<key> for client fields. Numbers come without units. GET /reports lists them with their ids.

Breaks — Planifizer API docs