Skip to Content
InvyteDocs
Clients & delivery

Get a Client

One Client's workspace: its contacts, its agreement (what it sees of candidates), its channels and its company profile. For anyone who sees one of its Jobs.

POST
/operations/clients.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/clients.get' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "clientId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "client": {      "id": "string",      "name": "string",      "websiteUrl": "string",      "accountOwnerUserId": "string",      "archivedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "canManage": true    },    "contacts": [      {        "id": "string",        "name": "string",        "email": "string",        "role": "hiring_manager",        "signsIn": true,        "createdAt": "2019-08-24T14:15:22Z"      }    ],    "agreement": {      "version": 0,      "preset": "balanced",      "overrides": {        "candidates": "delivered",        "pipelineNumbers": true,        "name": "first_name",        "contactDetails": "on_release",        "resumeFile": true,        "workHistory": true,        "education": true,        "skills": true,        "umatch": "off",        "aiInterviews": "off",        "recruiterNotes": true,        "verifiedBadge": true      },      "disclosure": {        "candidates": "delivered",        "pipelineNumbers": true,        "name": "first_name",        "contactDetails": "on_release",        "resumeFile": true,        "workHistory": true,        "education": true,        "skills": true,        "umatch": "off",        "aiInterviews": "off",        "recruiterNotes": true,        "verifiedBadge": true      },      "setAt": "2019-08-24T14:15:22Z",      "setByUserId": "string"    },    "channels": [      {        "kind": "email",        "status": "pending"      }    ],    "knowledge": {      "clientId": "string",      "status": "none",      "version": 0,      "websiteUrl": "string",      "profile": {        "summary": "string",        "whatTheyDo": "string",        "products": [          "string"        ],        "customers": "string",        "mission": "string",        "vision": "string",        "goals": [          "string"        ],        "stage": "string",        "fundingSignals": [          "string"        ],        "locations": [          "string"        ],        "techStack": [          "string"        ],        "culture": [          "string"        ],        "industry": {          "value": "string",          "source": "http://example.com",          "confidence": "stated"        },        "companyType": {          "value": "early_stage_startup",          "source": "http://example.com",          "confidence": "stated"        },        "fundingStage": {          "value": "string",          "source": "http://example.com",          "confidence": "stated"        },        "lastRound": {          "series": "string",          "amount": "string",          "announcedOn": "string",          "investors": [            "string"          ],          "source": "http://example.com",          "confidence": "stated"        },        "foundedYear": {          "value": -9007199254740991,          "source": "http://example.com",          "confidence": "stated"        },        "headquarters": {          "value": "string",          "source": "http://example.com",          "confidence": "stated"        },        "headcount": {          "band": "1-10",          "stated": "string",          "source": "http://example.com",          "confidence": "stated"        },        "remotePolicy": {          "value": "remote",          "source": "http://example.com",          "confidence": "stated"        },        "leadership": [          {            "name": "string",            "title": "string",            "source": "http://example.com",            "confidence": "stated"          }        ],        "hiring": {          "careersUrl": "http://example.com",          "facts": [            "string"          ],          "source": "http://example.com",          "confidence": "stated"        },        "news": [          {            "headline": "string",            "publishedOn": "string",            "source": "http://example.com"          }        ],        "sources": [          "http://example.com"        ],        "crawledAt": "2019-08-24T14:15:22Z"      },      "failureCode": "string"    }  },  "actionId": "string"}

Add a Client POST

Add a Client: a company you hire for, with its first hiring manager (who gets email from you; signing in is optional), its website and who runs it. Its email channel opens at once and its website is read into a company profile in the background.

Read a Client's company profile POST

What the Client's website, and public pages about it, say: what they do, products, customers, mission, vision, goals, stage, locations, tech stack and culture; and, each with the page it came from and whether it was stated, reported or inferred, its industry, company type, funding stage and last round, founded year, headquarters, headcount band, remote policy, leadership, hiring facts and recent news. A fact left out is unknown. Use it to write Job descriptions and sourcing criteria.