Skip to Content
InvyteDocs

Read notes on a candidate

The team's notes on a candidate's application, newest first, with who wrote each: all of them, or those on one workflow step or Activity Run.

POST
/operations/notes.list

Authorization

bearer
headerAuthorizationBearer <API key or OAuth token>

An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.

Header Parameters

Idempotency-Key?string

Makes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.

Match^[A-Za-z0-9._:-]+$
Length8 <= length <= 128

Request Body

application/json
  1. body
input*
confirmation?string

The id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.

Response Body

Done. A replay of the same key and input omits output.

application/json
  1. response
status*unknown
output?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/notes.list' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "applicationId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "notes": [      {        "noteId": "string",        "type": "CANDIDATE",        "stageId": "string",        "context": "string",        "authorName": "string",        "mine": true,        "content": "string",        "rating": 0,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ]  },  "actionId": "string"}