Skip to main content
GET
Retrieve client notes

Path Parameters

clientId
string
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Query Parameters

offset
integer<int16>
default:0

The offset for pagination. Defaults to 0.

Required range: 0 <= x <= 32767
limit
integer<int16>
default:20

The maximum number of results to return. Defaults to 20.

Required range: 1 <= x <= 100

Response

Ok. The operation succeeded.

items
object[]
required
count
integer<int16>
required
Required range: x >= 0
offset
integer<int16>

The offset of list results for the current page, when available.

Required range: x >= 0
limit
integer<int16>

The maximum number of results included in items, when available.

Required range: x >= 0