Skip to main content

Documentation Index

Fetch the complete documentation index at: https://staplehire.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Create an interview design for a role, then send it to a candidate or generate a link. 
DESIGN_ID=$(staplehire designs create <roleId> --type structured --brief "Async screening." | jq -r '.interview_design.id')
staplehire candidates send-interview <candidateId> --design "$DESIGN_ID"

​
Quickstart

DESIGN_ID=$(staplehire designs create <roleId> \
  --type structured \
  --brief "Async screening for backend fundamentals." \
  --round-title "Backend screen" \
  | jq -r '.interview_design.id')

staplehire candidates send-interview <candidateId> --design "$DESIGN_ID"
Example design output: 
{
  "interview_design": {
    "id": "design_...",
    "role_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "structured",
    "round_title": "Backend screen"
  }
}

​
Parameters

CommandFlagRequiredDescription
designs create<roleId>YesRole for the interview design
designs create--type <type>NoInterview design type, for example structured
designs create--brief <text>NoInstructions for the generated design
designs create--round-title <title>NoCandidate-facing interview round title
candidates send-interview<candidateId>YesCandidate to invite
candidates send-interview--design <designId>YesInterview design to send
candidates send-interview`—mode emaillink`NoSend email or return a link

​
Examples

​
Send an interview email

staplehire candidates send-interview <candidateId> --design <designId> --mode email

staplehire candidates interview-link <candidateId> --design <designId>
Example output: 
{ "interview_link": "https://staplehire.com/apply/..." }

​
List interview sessions

staplehire sessions list <roleId>
staplehire sessions list <roleId> --candidate-email alex@company.com

​
Common errors

ErrorCauseFix
NotFoundErrorCandidate or design ID is wrongUse candidates get and designs get
ValidationErrorMissing --designPass the design ID returned by designs create
PermissionErrorKey cannot send invitesCheck organization permissions

​
FAQ

​
Do I need a design before sending an interview?

Yes. Create a design with staplehire designs create, then pass its ID to candidates send-interview. Yes. Use candidates interview-link or send-interview --mode link.

​
What are deprecated aliases?

interview-design is a deprecated alias for designs, and interview-sessions is a deprecated alias for sessions. Related: Add a candidate with the Staplehire CLI · Command reference · CLI errors