Skip to Content
InvyteDocs

Preview a share as its recipients see it

What recipients of a Candidate Share see right now, per candidate: the name (unless hidden), the sections they see masked, the evaluation, each interview and assessment round at its level, and whether the resume file and hiring team notes are shared. Recordings and files open only in the app.

POST
/operations/shares.preview

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/shares.preview' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "shareId": "6a9e781b-5ee2-4314-8665-1c09eed0443a"  }}'
Example Response
{  "status": "done",  "output": {    "shareId": "string",    "status": "OPEN",    "name": "string",    "jobTitle": "string",    "allowViewerInvites": true,    "candidates": [      {        "subjectId": "string",        "name": "string",        "hidden": [          "string"        ],        "evaluation": {          "score": 0,          "summary": "string"        },        "rounds": [          {            "title": "string",            "kind": "INTERVIEW",            "level": "FULL",            "score": 0,            "summary": "string"          }        ],        "resumeShared": true,        "notesShared": 0,        "fit": "string"      }    ]  },  "actionId": "string"}