users

Get a user's snooze history

Changed on

Retrieves the snooze activity log for a specific user. Each entry shows a past snooze event with the snooze type (reason), start/end timestamps, and duration. Use this to audit a user's availability patterns over time.

Permission: No specific permission required. A valid API key is sufficient.

Monitoring: Not needed. This route works regardless of the Monitoring flag.

get/users/{userId}/snooze/log

Request

  • Base URL
    https://public-api.ringover.com/v2
  • URL
    https://public-api.ringover.com/v2/users/{userId}/snooze/log
  • Auth
    API key in header Authorization

Path parameters

userIdinteger required

The identifier of the user

Query parameters

limit_countinteger
Example:100

Maximum number of results to return per page. Default: server-defined.

limit_offsetinteger

Number of results to skip for pagination. Default: 0.

Response

Successful operation

user_idinteger
team_idinteger
last_id_offset_settedinteger

The request will return <b>cdr_id</b> (call logs) prior to this one

limit_count_settedinteger
snooze_log_list_countinteger

The size of the array <em>list</em>, corresponds to the number of logs retrieved

total_snooze_log_countinteger

The total number of snooze logs

Example response

{
  "user_id": 234234,
  "team_id": 234234,
  "last_id_offset_setted": 19479170,
  "limit_count_setted": 1,
  "snooze_log_list_count": 1,
  "snooze_log_list": [
    {
      "state": "state",
      "name": "name",
      "label": "label",
      "label_fr": "label",
      "label_en": "label",
      "label_es": "label",
      "comment": "a comment",
      "creation_date": "2018-08-12T12:12:40.53Z",
      "end_date": "2018-08-12T12:12:40.53Z"
    }
  ],
  "total_snooze_log_count": 1337
}

Changes

  • d92d55716cc3Revision changes
    • breaking

      the // response's property format changed from date to date-time for status

    • breaking

      the // response's property format changed from date to date-time for status

    • breaking

      removed the success response with the status

    • info

      api operation id getUsersUseridSnoozeLog was added