Skip to Content
InvyteDocs

List Clients

List the Clients (the customers a staffing organization hires for) whose Jobs you can see, by name, with how many of their Jobs you can see, their account owner, contacts and Slack status. Administrators see every Client.

POST
/operations/clients.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/clients.list' \  -H 'Content-Type: application/json' \  -d '{  "input": {}}'
Example Response
{  "status": "done",  "output": {    "clients": [      {        "id": "string",        "name": "string",        "archivedAt": "2019-08-24T14:15:22Z",        "jobCount": 0,        "websiteUrl": "string",        "accountOwnerUserId": "string",        "contactCount": 0,        "slackChannelStatus": "none"      }    ]  },  "actionId": "string"}