Skip to Content
InvyteDocs
Jobs & workflows

View a workflow template

See one workflow template's steps, their settings, and how candidates move between them.

POST
/operations/workflows.getTemplate

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/workflows.getTemplate' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "templateId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "template": {      "id": "string",      "name": "string",      "description": "string",      "category": "string",      "scope": "PLATFORM",      "stageCount": 0,      "updatedAt": "2019-08-24T14:15:22Z"    },    "steps": [      {        "id": "string",        "type": "string",        "kind": "string",        "title": "string",        "config": {          "property1": null,          "property2": null        },        "parentId": "string"      }    ],    "connections": [      {        "from": "string",        "to": "string",        "branch": "string"      }    ],    "ruleFields": [      {        "stepId": "string",        "field": "string",        "label": "string",        "type": "string",        "description": "string",        "numeric": {          "min": 0,          "max": 0,          "step": 0,          "displayScale": 0,          "unit": "percent"        },        "options": [          {            "value": "string",            "label": "string"          }        ]      }    ]  },  "actionId": "string"}

View a Job's workflow draft POST

See the workflow draft being prepared for a Job (its steps, revision and what still needs fixing) and the workflow assigned now. Edit it with workflows.saveJobDraft.

View a workflow POST

See one workflow from the library or a Job: its steps, their settings, and how candidates move between them.