WOworkiz
Client Notes

Retrieve a list of Client Notes

Changed on

Returns a paginated list of notes for the given client, ordered by creation date descending.

get/v2/clients/{clientId}/notes

Request

Path parameters

clientIdstring required
Example:CL-OvmDp2yvv1yqMwRl

The client ID (prefix CL-).

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

Paginated list of client notes.

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": "CLN-211d1676f4b90c40",
      "note": "Customer requested a follow-up call.",
      "techName": "John Doe",
      "createdAt": "2021-01-01 00: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