Skip to content

Create an interview

Opportunities module

POST/interviewsinterviews.create

An interview or audition for an application. Creates an interview. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability opportunities.application.review.
  • OAuth scopes: opportunities.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: InterviewCreate

interviews.create: InterviewCreate
FieldTypeRequiredDescription
application_idstring (uuid)YesIdentifier of the application.
scheduled_atstring (date-time)YesWhen it is scheduled.
interview_kind"Interview" | "Audition"YesInterview or Audition.
duration_minutesintegerYesLength in minutes.Constraints: range 1 to any
location_textstring | nullNoPlace or meeting link.Constraints: length 1 to 2000
internal_notestring | nullNoInternal note. Never visible externally.Constraints: length 1 to 20000
{
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scheduled_at": "2026-10-08T14:30:00Z",
  "interview_kind": "Interview",
  "duration_minutes": 30,
  "location_text": "Production office, Hall B",
  "internal_note": "Strong rigging resume."
}

Response 201: Interview

interviews.create: Interview
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the interview.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
application_idstring (uuid)YesIdentifier of the application.
scheduled_atstring (date-time)YesWhen it is scheduled.
interview_kind"Interview" | "Audition"YesInterview or Audition.
duration_minutesintegerYesLength in minutes.Constraints: range 1 to any
location_textstring | nullYesPlace or meeting link.Constraints: length 1 to 2000
internal_notestring | nullYesInternal note. Never visible externally.Constraints: length 1 to 20000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scheduled_at": "2026-10-08T14:30:00Z",
  "interview_kind": "Interview",
  "duration_minutes": 30,
  "location_text": "Production office, Hall B",
  "internal_note": "Strong rigging resume."
}

Code samples

curl -X POST "$XOS_BASE_URL/interviews" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scheduled_at":"2026-10-08T14:30:00Z","interview_kind":"Interview","duration_minutes":30,"location_text":"Production office, Hall B","internal_note":"Strong rigging resume."}'
const { data } = await xos.interviews.create({
    "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "scheduled_at": "2026-10-08T14:30:00Z",
    "interview_kind": "Interview",
    "duration_minutes": 30,
    "location_text": "Production office, Hall B",
    "internal_note": "Strong rigging resume."
  });
response = xos.interviews.create({"application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "scheduled_at": "2026-10-08T14:30:00Z", "interview_kind": "Interview", "duration_minutes": 30, "location_text": "Production office, Hall B", "internal_note": "Strong rigging resume."})
xos interviews create --data '{"application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scheduled_at":"2026-10-08T14:30:00Z","interview_kind":"Interview","duration_minutes":30,"location_text":"Production office, Hall B","internal_note":"Strong rigging resume."}'