API Reference

candidate.listNotes

post
https://api.ashbyhq.com/candidate.listNotes

Lists the notes that have been added to a candidate, ordered from newest to oldest.

See the Pagination and Incremental Synchronization guide for cursor usage examples.

Requires the candidatesRead permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the candidate to fetch notes for

Opaque cursor indicating which page of results to fetch

Accepted for backward compatibility. This endpoint does not currently support incremental synchronization.

The maximum number of items to return. Explicit values are capped at 100. When omitted, up to 500 items are returned for backward compatibility.

Response

Updated 3 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago