Skip to main content
GET
List all notes

Authorizations

Authorization
string
header
required

HTTP Basic Authentication with API credentials

Query Parameters

candidate_id
integer

Filter notes for a specific candidate. This ID is provided by the .id field of the candidate detail resource.

organisation_id
integer

Filter notes for a specific organisation.

Response

Paginated list of notes

_self
string<uri-reference>
_schema
string<uri-reference>
_status
enum<string>
Available options:
OK
_next
string<uri-reference>

Next page; empty string on the last page.

items
object[]
_actions
object[]

[{"_self": "/restapi/v1/note", "doc": "Add a new note", "method": "POST"}]