WOworkiz
Events

Retrieve a list of Events

Changed on

Retrieves a paginated list of Events.

get/v2/event

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

field'start' | 'status'

Beta: This property is subject to change.

The field to sort results by. Must be combined with order.

order'ASC' | 'DESC'

Beta: This property is subject to change.

The sort direction. Must be combined with field. Defaults to DESC.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of Events.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "EVT-Dxgp7NRjo6kXb5eG",
      "title": "Doctor appointment",
      "description": "Doctor appointment with Dr. Smith",
      "start": "2024-07-25 09:00:00",
      "end": "2024-07-25 11:00:00",
      "techIds": [
        "USR-83510a9930f203f4",
        "USR-a4f86bf1deefec12",
        "USR-d59dbcd34aa19dce"
      ],
      "updatedAt": "2024-07-25 09:00:00",
      "createdAt": "2024-07-25 09:00:00"
    }
  ]
}

Changes

  • a2110eaa32f2Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • c308fa019f29Revision changes
    • info

      added the new optional query request parameter field

    • info

      added the new optional query request parameter order

    • info

      added the non-success response with the status