Skip to Content
InvyteDocs

View a Candidate Share

One Candidate Share: the candidates on it and what is shared about them, each recipient's access and invitation, when they opened it, and their fit marks and introduction requests.

POST
/operations/shares.get

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.get' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "shareId": "6a9e781b-5ee2-4314-8665-1c09eed0443a"  }}'
Example Response
{  "status": "done",  "output": {    "share": {      "shareId": "string",      "label": "string",      "jobTitle": "string",      "createdBy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "candidateCount": 0,      "activeRecipientCount": 0,      "live": true,      "pendingAccessRequests": 0,      "expiresAt": "2019-08-24T14:15:22Z",      "lastOpenedAt": "2019-08-24T14:15:22Z",      "status": "OPEN"    },    "jobId": "string",    "version": "string",    "candidates": [      {        "subjectId": "string",        "applicationId": "string",        "name": "string",        "jobTitle": "string",        "fields": [          "string"        ],        "evidence": [          "string"        ],        "sensitive": [          "string"        ]      }    ],    "recipients": [      {        "recipientId": "string",        "email": "string",        "status": "ACTIVE",        "invitedAt": "2019-08-24T14:15:22Z",        "expiresAt": "2019-08-24T14:15:22Z",        "revokedAt": "2019-08-24T14:15:22Z",        "invitation": {          "status": "string",          "sentAt": "2019-08-24T14:15:22Z",          "failedAt": "2019-08-24T14:15:22Z"        },        "firstOpenedAt": "2019-08-24T14:15:22Z",        "lastOpenedAt": "2019-08-24T14:15:22Z",        "verdicts": [          {            "subjectId": "string",            "verdict": "GOOD_FIT"          }        ],        "introductionRequests": [          {            "subjectId": "string",            "requestedAt": "2019-08-24T14:15:22Z"          }        ]      }    ]  },  "actionId": "string"}