Schedule an interview

Schedule an interview for an application at its current stage: title, start and end (ISO 8601 with offset), optional time zone (IANA, used to word the invitation), location or https meeting URL, and 1–10 interviewers from the hiring team. With sendInvitation the candidate gets the interview invitation email (templateId, else the workspace's, else Recruit's default) with interview.title, interview.when and interview.location filled in. Calendar, Sign and People are optional: times are entered here, and a signature or People record reference is stored when the team has one.

Outcome

Before you start

Verify identity and the pinned organization context, then discover the exact action and a granted Recruit workspace.
The required application permission is workspace:write. Hiring-team roles and record visibility are enforced separately; a workspace grant alone does not grant every Recruit action.
Organization and workspace identity come from verified context. Pass the workspace as resourceType/resourceId, separate from action input; request-body organizationId/workspaceId values cannot select an authorized scope.
The first authorized action can initialize an identity-only workspace mirror and invoke the configured workspace-created callback. It does not create an Auth workspace or grant new access.

Recruiters can perform the full hiring workflow. Hiring managers see their managed roles and candidates; interviewers see assigned interviews and their candidates. Workspace owners and organization administrators act as recruiters. Use team.me to read the caller's effective role and allowed actions.

Discover the target

topolo whoami --json
topolo actions get app_topolo_recruit.interviews.schedule --detail --json
topolo resources topolo-recruit --json
topolo workspaces list topolo-recruit --json
topolo actions get app_topolo_recruit.team.me --detail --json
topolo actions get app_topolo_recruit.interviews.list --detail --json
topolo actions get app_topolo_recruit.applications.list --detail --json
topolo actions get app_topolo_recruit.team.list --detail --json
topolo actions get app_topolo_recruit.email_templates.list --detail --json

Request

POST /api/interviews

Save input as payload.json. CLI and MCP action input includes path identifiers. The reviewed plan separates path/query fields from the HTTP body. Set RECRUIT_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console. Use its discovered schema and plan; a test response still requires the verification described below.

Input fields

Field	Required	Type	Constraints
`applicationId`	Required	string	Application id from applications.list in the same workspace. {"minLength":1,"maxLength":64}
`title`	Required	string	{"minLength":1,"maxLength":200}
`startsAt`	Required	string	{"pattern":"^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z\|(+-:[0-5]\d)))$"}
`endsAt`	Required	string	{"pattern":"^(?:(?:\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|[02468][048]00\|[13579][26]00)-02-29\|\d{4}-(?:(?:0[13578]\|1[02])-(?:0[1-9]\|[12]\d\|3[01])\|(?:0[469]\|11)-(?:0[1-9]\|[12]\d\|30)\|(?:02)-(?:0[1-9]\|1\d\|2[0-8])))T(?:(?:[01]\d\|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z\|(+-:[0-5]\d)))$"}
`timezone`	Optional	string	{"minLength":1,"maxLength":64}
`location`	Optional	Union	{}
`meetingUrl`	Optional	Union	{}
`interviewerUserIds`	Required	array	Topolo user ids of hiring-team members; inspect team.list before scheduling an interview. {"minItems":1,"maxItems":10}
`sendInvitation`	Optional	boolean	{}
`templateId`	Optional	string	Template id from email_templates.list; inspect kind and active status before using it. {"minLength":1,"maxLength":64}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "applicationId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "startsAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "endsAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "location": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "meetingUrl": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000,
          "pattern": "^https:\\/\\/"
        },
        {
          "type": "null"
        }
      ]
    },
    "interviewerUserIds": {
      "minItems": 1,
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "sendInvitation": {
      "type": "boolean"
    },
    "templateId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "applicationId",
    "title",
    "startsAt",
    "endsAt",
    "interviewerUserIds"
  ],
  "additionalProperties": false
}

Effects

Creates one interview with its interviewers, adds a timeline entry and, with sendInvitation, requests one email.

Interpret the response

Call interviews.get with $.interview.id; with sendInvitation check invitation.status and candidates.emails.list.

The response identifier path is $.interview.id for interview. Lists may be empty; an empty list is not a discovered target.

Exact success schema:

{
  "type": "object",
  "required": [
    "interview"
  ],
  "properties": {
    "interview": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "applicationId": {
          "type": "string"
        },
        "candidateId": {
          "type": "string"
        },
        "roleId": {
          "type": "string"
        },
        "stageId": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "startsAt": {
          "type": "string"
        },
        "endsAt": {
          "type": "string"
        },
        "timezone": {
          "type": [
            "string",
            "null"
          ]
        },
        "location": {
          "type": [
            "string",
            "null"
          ]
        },
        "meetingUrl": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "enum": [
            "scheduled",
            "completed",
            "cancelled"
          ]
        },
        "interviewerUserIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "candidateName": {
          "type": "string"
        },
        "roleTitle": {
          "type": "string"
        },
        "interviewers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "userId": {
                "type": "string"
              },
              "displayName": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        }
      }
    },
    "invitation": {
      "type": [
        "object",
        "null"
      ]
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. A synthetic fixture identifier grants no access. Validate and inspect the planned request before executing. Commands with --confirm or MCP confirm:true assume the intended effect or data export has already been authorized.

Successful request

Actual dispatcher and migration-created SQLite; verified Auth/workspace context, object storage, mail and Notify dependencies are simulated. No live delivery or credential authorization is established. This complete response is a local fixture, not a deployed or delivered result.

Input · payload.json:

{
  "applicationId": "apl_10a5c7b95326410b9385fc026d7b42b6",
  "title": "Design",
  "startsAt": "2026-10-06T09:00:00Z",
  "endsAt": "2026-10-06T10:00:00Z",
  "interviewerUserIds": [
    "u_admin"
  ]
}

CLI:

topolo actions validate app_topolo_recruit.interviews.schedule --data @payload.json --json
topolo actions plan app_topolo_recruit.interviews.schedule --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.interviews.schedule --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.interviews.schedule",
    "input": {
      "applicationId": "apl_10a5c7b95326410b9385fc026d7b42b6",
      "title": "Design",
      "startsAt": "2026-10-06T09:00:00Z",
      "endsAt": "2026-10-06T10:00:00Z",
      "interviewerUserIds": [
        "u_admin"
      ]
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "interview": {
    "id": "int_05303c510c0e47c5adcb7edbb110fd7f",
    "applicationId": "apl_10a5c7b95326410b9385fc026d7b42b6",
    "candidateId": "cand_ee8671027d8d4835aa81b9b3ab1b8399",
    "roleId": "role_51b53e37da7248fcbe19d3c4e204bfc7",
    "stageId": "stg_5418ee6dd7e14535bae7cdea2d261668",
    "title": "Design",
    "startsAt": "2026-10-06T09:00:00Z",
    "endsAt": "2026-10-06T10:00:00Z",
    "timezone": null,
    "location": null,
    "meetingUrl": null,
    "status": "scheduled",
    "interviewerUserIds": [
      "u_admin"
    ],
    "candidateName": "Ada L",
    "createdBy": "u_admin",
    "createdAt": "2026-10-05T09:00:00.000Z",
    "updatedAt": "2026-10-05T09:00:00.000Z"
  },
  "invitation": null
}

HTTP 201. Call interviews.get with $.interview.id; with sendInvitation check invitation.status and candidates.emails.list.

Another supported request

Input · payload.json:

{
  "applicationId": "apl_d8617fa5a2eb4014b24ab7c5f0679d76",
  "title": "Tech",
  "startsAt": "2026-10-06T09:00:00Z",
  "endsAt": "2026-10-06T10:00:00Z",
  "interviewerUserIds": [
    "u_int"
  ]
}

CLI:

topolo actions validate app_topolo_recruit.interviews.schedule --data @payload.json --json
topolo actions plan app_topolo_recruit.interviews.schedule --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_recruit.interviews.schedule --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_recruit.interviews.schedule",
    "input": {
      "applicationId": "apl_d8617fa5a2eb4014b24ab7c5f0679d76",
      "title": "Tech",
      "startsAt": "2026-10-06T09:00:00Z",
      "endsAt": "2026-10-06T10:00:00Z",
      "interviewerUserIds": [
        "u_int"
      ]
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 201:

{
  "interview": {
    "id": "int_a9f94d38d9bc49b5844234a7724a977c",
    "applicationId": "apl_d8617fa5a2eb4014b24ab7c5f0679d76",
    "candidateId": "cand_16181d6f07674ffba717f8aeebdd5a5c",
    "roleId": "role_937d75e815a84277a434f5903130a0ab",
    "stageId": "stg_2a5b95c739d440a98a137f310955abb5",
    "title": "Tech",
    "startsAt": "2026-10-06T09:00:00Z",
    "endsAt": "2026-10-06T10:00:00Z",
    "timezone": null,
    "location": null,
    "meetingUrl": null,
    "status": "scheduled",
    "interviewerUserIds": [
      "u_int"
    ],
    "candidateName": "Ada Lovelace",
    "createdBy": "u_admin",
    "createdAt": "2026-10-05T09:00:00.000Z",
    "updatedAt": "2026-10-05T09:00:00.000Z"
  },
  "invitation": null
}

HTTP 201. Call interviews.get with $.interview.id; with sendInvitation check invitation.status and candidates.emails.list.

Refused request · not_found

Input · payload.json:

{
  "applicationId": "apl_32f12ca265014e1089400af9232d84ab",
  "title": "x",
  "startsAt": "2026-10-06T09:00:00+01:00",
  "endsAt": "2026-10-06T10:00:00+01:00",
  "timezone": "Europe/London",
  "interviewerUserIds": [
    "u_int"
  ],
  "templateId": "tpl_missing"
}

CLI:

topolo actions validate app_topolo_recruit.interviews.schedule --data @payload.json --json
topolo actions plan app_topolo_recruit.interviews.schedule --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Email template was not found in this workspace."
  }
}

HTTP 404. Preserve the exact response code and details. Do not claim success.

Refused request · hiring_team_role_required

Input · payload.json:

{
  "applicationId": "apl_example",
  "title": "Technical interview",
  "startsAt": "2026-10-06T09:00:00+01:00",
  "endsAt": "2026-10-06T10:00:00+01:00",
  "timezone": "Europe/London",
  "meetingUrl": "https://meet.example.com/abc",
  "interviewerUserIds": [
    "usr_example"
  ],
  "sendInvitation": true
}

CLI:

topolo actions validate app_topolo_recruit.interviews.schedule --data @payload.json --json
topolo actions plan app_topolo_recruit.interviews.schedule --resource-type workspace --resource-id "$RECRUIT_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": {
    "code": "hiring_team_role_required",
    "message": "Your hiring-team role in this workspace does not allow this action.",
    "details": {
      "teamRole": "interviewer",
      "allowedRoles": [
        "recruiter",
        "hiring_manager"
      ]
    }
  }
}

HTTP 403. Preserve the exact response code and details. Do not claim success.

Verify the result

Call interviews.get with $.interview.id; with sendInvitation check invitation.status and candidates.emails.list.

Errors and recovery

organization_context_required (HTTP 403): Select the organization authorized by the credential; do not send an organization id in the action input.
permission_denied (HTTP 403): Grant the credential the required Recruit workspace permission.
hiring_team_role_required (HTTP 403): Ask a recruiter to give the caller a hiring-team role that allows this action (team.members.set); error.details lists the allowed roles.
workspace_required (HTTP 409): Create a Recruit workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
not_found (HTTP 404): List applications or email templates to find a valid id. Records outside the caller's hiring-team view also answer 404.
role_not_managed (HTTP 403): Only a recruiter or the role's hiring manager can do this.
application_withdrawn (HTTP 409): The candidate withdrew; nothing can change on this application.
invalid_time_range (HTTP 422): endsAt must be after startsAt.
interviewer_not_on_team (HTTP 422): Add each interviewer with team.members.set first (error.details.unknown).
invalid_json (HTTP 400): Send a valid JSON object. The request is rejected before workspace resolution or record creation.

Authentication or gateway failures may occur before the Recruit handler. Preserve the exact discovered service error, request id and credential context. The local fixtures do not establish live credential authorization.

Recovery boundary

Cancel the interview; an invitation already sent cannot be recalled (send the candidate a note with candidates.emails.send).

Cancel an interview: Cancel a scheduled interview with an optional reason. Draft scorecards for it can no longer be saved.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; Auth/workspace identity, object storage, mail and Notify dependencies are simulated. These synthetic fixtures establish no live authorization or delivery. Test capture provenance is retained with each fixture. API, database and integration outcomes require separate verification in the target environment.

Schedule an interview

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · not_found

Refused request · hiring_team_role_required

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence