Get Users Breaks

Returns the break sessions recorded for users within a time period.

When to use. Report on when agents were on break, optionally narrowed to specific users or break types. To look up the available break types and their IDs, use GET /users/breaks.

Parameters.

  • from, till (path): start and end of the period.
  • user_ids (path): comma-separated user IDs to include.
  • break_ids (path): comma-separated break IDs to include.

Returns. { "usersBreaks": [ { "user_id": 5, "break_id": 2, "start_break": "...", "end_break": "..." } ] }.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Period start.

string
required

Period end.

string
required

Comma-separated user IDs to limit results.

string
required

Comma-separated break IDs to limit results.

Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json