Skip to main content
GET
Get Company Notes
This endpoint uses the Company Note object.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

companyId
string
required

The unique identifier of the company

Query Parameters

limit
integer

Number of notes to retrieve. Default: 100. Maximum: 100

page
integer

Page number to retrieve

sortBy
enum<string>

The field by which to sort. Currently, only 'createdAt' is supported.

Available options:
createdAt
sortOrder
enum<string>

The sort direction. Use 'desc' for descending order; any other value (or omission) will sort in ascending order.

Available options:
asc,
desc

Response

Success

data
object[]
required
total
integer
required