--- title: "interviewBriefing.info" method: POST path: "/interviewBriefing.info" tags: ["Interview Briefing"] --- # interviewBriefing.info `POST /interviewBriefing.info` Fetch the briefing data for an interview event. Returns the application, interview, per-interviewer status, and the feedback form definition id needed to render an interviewer-facing briefing or to submit feedback via [`applicationFeedback.submit`](applicationfeedbacksubmit). By default, each interviewer in the response is returned as a `userId` with status flags. Pass `expand: ["interviewers"]` to include the full user and pool details for each interviewer. Other expansions return the application, candidate, job, interview, and feedback form definition inline. **Requires the [`interviewsRead`](authentication#permissions-interviewbriefinginfo) permission.** ## Request body - InterviewBriefingInfoRequest - `interviewEventId` string, uuid, required — The id of the interview event whose briefing should be returned. - `expand` string[], nullable — Choose to expand the result and include additional data for related objects. ## Response `200` Responses from the interviewBriefing.info endpoint - union - InterviewBriefingInfoSuccessResponse - `success` true, required - `results` InterviewBriefing, required - `id` string, uuid, required — The interview event's id - `applicationId` string, uuid, required — The id of the application this briefing is for - `interviewId` string, uuid, required — The id of the interview - `interviewStageId` string, uuid, required — The id of the interview stage this event belongs to - `interviewers` BriefingInterviewer[], required — The interviewers assigned to this event. By default each entry contains a `userId` with status flags; pass `expand: ["interviewers"]` to include the full user and pool details. - `userId` string, uuid, required — The user id of the interviewer - `isFeedbackRequired` boolean, required — Whether feedback is required from this interviewer for this specific event. - `hasSubmittedFeedback` boolean, required — Whether this interviewer has already submitted a scorecard for this event. - `trainingRole` 'Shadow' | 'ReverseShadow', required - `user` User - `id` string, uuid, required — The unique identifier for the user - `firstName` string, required — The user's first name - `lastName` string, required — The user's last name - `email` string, email, nullable, required — The user's email address - `globalRole` 'Organization Admin' | 'Elevated Access' | 'Limited Access' | 'External Recruiter', required — The user's global role in the organization - `isEnabled` boolean, required — Whether the user is enabled (not deactivated) - `updatedAt` string, required — The timestamp when the user was last updated (ISO 8601 format) - `managerId` string, uuid — The unique identifier for the user's manager - `customFields` CustomField[] — Custom fields associated with the user (only included when requested) - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean, required — Whether the custom field is private - `title` string, required — The title of the custom field - `value` union, required — The value of the custom field - … - `valueLabel` union — The label of the custom field value. This is only present for value select custom fields. - … - `interviewerPool` InterviewerPoolBrief - `id` string, uuid, required — The unique identifier for the interviewer pool - `title` string, required — The title of the interviewer pool - `isArchived` boolean, required — Whether the interviewer pool is archived - `hasSubmittedFeedback` boolean, required — Whether any interviewer on this event has submitted a scorecard. - `feedbackFormDefinitionId` string, uuid, required — The id of the feedback form definition that should be used to render and submit feedback for this event. - `feedbackFormDefinition` FeedbackFormDefinition - `id` string, uuid, required — The unique identifier for the feedback form definition - `organizationId` string, uuid, required — The unique identifier for the organization - `title` string, required — The title of the feedback form definition - `isArchived` boolean, required — Whether the feedback form definition is archived - `isDefaultForm` boolean, required — Whether this is the organization's default feedback form definition - `formDefinition` FormDefinition, required - `sections` FormDefinitionSection[], required — The sections in the form definition - `title` string, nullable — The section title - `descriptionHtml` string, nullable — The section description formatted as HTML - `descriptionPlain` string, nullable — The section description as plain text - `fields` FormDefinitionFieldEntry[], required — The fields in this form section - … - `interviewId` string, uuid, nullable — The interview this feedback form definition belongs to, if interview-specific - `application` Application - `id` string, uuid, required — The unique identifier for the application - `createdAt` string, date-time, required — The timestamp when the application was created - `updatedAt` string, date-time, required — The timestamp when the application was last updated - `status` 'Hired' | 'Archived' | 'Active' | 'Lead', required — The status of the application - `customFields` object[], nullable — Custom fields attached to the application, if any - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean — Whether the custom field is private - `title` string, required — The title of the custom field - `valueLabel` union — The human-readable label for select custom field values - string - string[] - `value` union, required — The custom field value - boolean - number - string - string[] - object - … - object - … - object - … - `candidate` object, required — The candidate associated with the application - `id` string, uuid, required — The unique identifier for the candidate - `name` string, required — The candidate's name - `primaryEmailAddress` object, nullable — The candidate's primary email address, if any - `value` string, required — The email address or phone number of the candidate - `type` 'Personal' | 'Work' | 'Other', required — The type of the contact info - `isPrimary` boolean, required — Whether the contact info is the primary email or phone number - `primaryPhoneNumber` object, nullable — The candidate's primary phone number, if any - `value` string, required — The email address or phone number of the candidate - `type` 'Personal' | 'Work' | 'Other', required — The type of the contact info - `isPrimary` boolean, required — Whether the contact info is the primary email or phone number - `currentInterviewStage` object, required — The current interview stage for the application - `id` string, uuid, required — The unique identifier for the interview stage - `title` string, required — The interview stage title - `type` string, required — The interview stage type - `orderInInterviewPlan` integer, required — The stage's order within its interview plan - `interviewStageGroupId` string, uuid, nullable — The id of the interview stage group the stage belongs to, if any - `interviewPlanId` string, uuid, required — The id of the interview plan the stage belongs to - `source` object, nullable — The source attributed to this application, if any - `id` string, uuid, required — The source's unique identifier - `title` string, required — The title of the source - `isArchived` boolean, required — Whether the source has been archived - `sourceType` object, required — The source type associated with this source - `id` string, uuid, required — The source type's unique identifier - `title` string, required — The title of the source type - `isArchived` boolean, required — Whether the source type has been archived - `archiveReason` object, nullable — Details about the archive reason for this application, if archived - `id` string, uuid, required — The unique identifier for the archive reason - `text` string, required — The display text for the archive reason - `reasonType` 'RejectedByCandidate' | 'RejectedByOrg' | 'Other', required — The category of archive reason - `isArchived` boolean, required — Whether the archive reason is archived - `customFields` object[], required — Archive detail custom field values - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean — Whether the custom field is private - `title` string, required — The title of the custom field - `valueLabel` union — The human-readable label for select custom field values - … - `value` union, required — The custom field value - … - `archivedAt` string, date-time, nullable — The timestamp an application was archived - `job` object, required — The job the application is for - `id` string, uuid, required — The unique identifier for the job - `title` string, required — The job title - `locationId` string, uuid, nullable — The id of the job's primary location, if any - `departmentId` string, uuid, nullable — The id of the job's department, if any - `creditedToUser` User - `id` string, uuid, required — The unique identifier for the user - `firstName` string, required — The user's first name - `lastName` string, required — The user's last name - `email` string, email, nullable, required — The user's email address - `globalRole` 'Organization Admin' | 'Elevated Access' | 'Limited Access' | 'External Recruiter', required — The user's global role in the organization - `isEnabled` boolean, required — Whether the user is enabled (not deactivated) - `updatedAt` string, required — The timestamp when the user was last updated (ISO 8601 format) - `managerId` string, uuid — The unique identifier for the user's manager - `customFields` CustomField[] — Custom fields associated with the user (only included when requested) - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean, required — Whether the custom field is private - `title` string, required — The title of the custom field - `value` union, required — The value of the custom field - … - `valueLabel` union — The label of the custom field value. This is only present for value select custom fields. - … - `hiringTeam` HiringTeamRole[], required — The hiring team for the application - `userId` string, uuid, required — The unique identifier of the hiring team member - `firstName` string, required — The first name of the hiring team member - `lastName` string, required — The last name of the hiring team member - `email` string, email, required — The primary email address of the hiring team member - `role` string, required — The hiring team role assigned to the member - `appliedViaJobPostingId` string, uuid, nullable — The id of the first job posting the candidate applied through. If the candidate submitted applications via multiple job postings for the same job, this will be the earliest one. - `submitterClientIp` string, nullable — The IP address (can be v4 or v6) of the client that submitted the application, if it was submitted through the external job board. - `submitterUserAgent` string, nullable — The user agent of the client that submitted the application, if it was submitted through the external job board. - `candidate` Candidate - `id` string, uuid, required — The unique identifier for the candidate - `createdAt` string, required — The timestamp when the candidate was created - `updatedAt` string, required — The timestamp when the candidate was last updated - `name` string, required — The candidate's name - `primaryEmailAddress` ContactInfo, required - `value` string, required — The email address or phone number of the candidate - `type` 'Personal' | 'Work' | 'Other', required — The type of the contact info - `isPrimary` boolean, required — Whether the contact info is the primary email or phone number - `emailAddresses` ContactInfo[], required — The candidate's email addresses - `value` string, required — The email address or phone number of the candidate - `type` 'Personal' | 'Work' | 'Other', required — The type of the contact info - `isPrimary` boolean, required — Whether the contact info is the primary email or phone number - `primaryPhoneNumber` ContactInfo, required - `value` string, required — The email address or phone number of the candidate - `type` 'Personal' | 'Work' | 'Other', required — The type of the contact info - `isPrimary` boolean, required — Whether the contact info is the primary email or phone number - `phoneNumbers` ContactInfo[], required — The candidate's phone numbers - `value` string, required — The email address or phone number of the candidate - `type` 'Personal' | 'Work' | 'Other', required — The type of the contact info - `isPrimary` boolean, required — Whether the contact info is the primary email or phone number - `socialLinks` SocialLink[], required — The candidate's social links - `type` 'LinkedIn' | 'GitHub' | 'Twitter' | 'Medium' | 'StackOverflow' | 'Website' | 'YouTube' | 'CodePen', required — The type of social link - `url` string, required — The URL of the social profile - `tags` CandidateTag[], required — The candidate's tags - `id` string, uuid, required — The candidate tag's unique identifier - `title` string, required — The tag's title - `isArchived` boolean, required — Whether the tag has been archived - `position` string — The candidate's current position - `company` string — The candidate's current company - `school` string — The candidate's school - `applicationIds` string[], required — The unique identifiers of the candidate's applications - `resumeFileHandle` FileHandle, required - `id` string, uuid, required — The unique identifier for the file - `name` string, required — The file name - `handle` string, required — The file handle, which can be used with the file.info endpoint - `fileHandles` FileHandle[], required — The file handles associated with the candidate - `id` string, uuid, required — The unique identifier for the file - `name` string, required — The file name - `handle` string, required — The file handle, which can be used with the file.info endpoint - `customFields` CandidateCustomField[] — The custom field values associated with the candidate - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean, required — Whether the custom field is private - `title` string, required — The title of the custom field - `value` union, required — The custom field value - boolean - number - string - string[] - object - … - object - … - object - … - `valueLabel` union — The human-readable label for select custom field values - string - string[] - `profileUrl` string, required — The URL of the candidate's profile in Ashby - `source` Source - `id` string, uuid, required — The source's unique identifier - `title` string, required — The title of the source - `isArchived` boolean, required — Whether the source has been archived - `sourceType` SourceType, required - `id` string, uuid, required — The source type's unique identifier - `title` string, required — The title of the source type - `isArchived` boolean, required — Whether the source type has been archived - `creditedToUser` User - `id` string, uuid, required — The unique identifier for the user - `firstName` string, required — The user's first name - `lastName` string, required — The user's last name - `email` string, email, nullable, required — The user's email address - `globalRole` 'Organization Admin' | 'Elevated Access' | 'Limited Access' | 'External Recruiter', required — The user's global role in the organization - `isEnabled` boolean, required — Whether the user is enabled (not deactivated) - `updatedAt` string, required — The timestamp when the user was last updated (ISO 8601 format) - `managerId` string, uuid — The unique identifier for the user's manager - `customFields` CustomField[] — Custom fields associated with the user (only included when requested) - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean, required — Whether the custom field is private - `title` string, required — The title of the custom field - `value` union, required — The value of the custom field - … - `valueLabel` union — The label of the custom field value. This is only present for value select custom fields. - … - `timezone` string, nullable — The candidate's timezone - `location` CandidateLocation - `id` string, uuid, required — The unique identifier for the location - `locationSummary` string, nullable, required — A human-readable summary of the location - `locationComponents` CandidateLocationComponent[], nullable, required — The individual components of the location - `type` string, required — The type of the location component - `name` string, required — The name of the location component - `fraudStatus` 'Fraudulent' | 'NotFraudulent' | 'Unsure' | 'Unreviewed' | 'PassedFraudCheck', nullable — The fraud status of the candidate - `job` Job - `id` string, uuid, required — The job's unique identifier - `title` string, required — The title of the job - `confidential` boolean, required — Whether the job is confidential - `status` 'Draft' | 'Open' | 'Closed' | 'Archived', required - `employmentType` 'FullTime' | 'PartTime' | 'Intern' | 'Contract' | 'Temporary', required — The employment type for the job - `locationId` string, uuid — The id of the location associated with the job - `departmentId` string, uuid — The id of the department or team associated with the job - `defaultInterviewPlanId` string, uuid — The id of the default interview plan for this job. A job cannot be opened without a default interview plan. - `interviewPlanIds` string[] — The ids of all interview plans associated with the job - `jobPostingIds` string[] — The ids of all job postings associated with the job - `customRequisitionId` string, nullable — The custom requisition id for the job - `brandId` string, uuid, required — The id of the brand to use for this job - `hiringTeam` JobHiringTeamRole[], required — The hiring team for the job - `userId` string, uuid, required — The unique identifier for the user - `firstName` string, required — The user's first name - `lastName` string, required — The user's last name - `email` string, email, required — The user's email address - `role` string, required — The user's role on the job's hiring team - `openings` Opening[] — The openings linked to this job. Only included when the `openings` expand parameter is provided. - `id` string, uuid, required — The unique identifier for the opening - `openedAt` string, date-time, nullable, required — The timestamp when the opening was opened - `closedAt` string, date-time, nullable, required — The timestamp when the opening was closed - `isArchived` boolean, required — Whether the opening is archived - `closeReasonId` string, uuid, nullable, required — The unique identifier for the close reason - `archivedAt` string, date-time, nullable, required — The timestamp when the opening was archived - `openingState` 'Draft' | 'Approved' | 'Open' | 'Closed' | 'Filled', required — The current state of the opening - `latestVersion` OpeningVersion, required - `id` string, uuid, required — The unique identifier for the opening version - `identifier` string, required — The human-readable opening identifier - `description` string, nullable, required — The opening description - `authorId` string, uuid, nullable, required — The unique identifier for the author - `createdAt` string, date-time, required — The timestamp when the opening version was created - `targetHireDate` string, nullable, required — The target hire date for the opening - `targetStartDate` string, nullable, required — The target start date for the opening - `isBackfill` boolean, required — Whether the opening is a backfill - `employmentType` 'FullTime' | 'PartTime' | 'Intern' | 'Contract' | 'Temporary', required — The employment type for the opening - `teamId` string, uuid, nullable, required — The unique identifier for the team - `jobIds` string[], required — The unique identifiers for jobs linked to the opening - `locationIds` string[], required — The unique identifiers for locations linked to the opening - `hiringTeam` OpeningHiringTeamRole[], required — The hiring team roles assigned to the opening - … - `customFields` OpeningCustomField[], required — Custom fields associated with the opening - … - `location` Location - `id` string, uuid, required — The unique identifier for the location - `name` string, required — The name of the location - `externalName` string, nullable, required — An alternate candidate-facing name for this location used on job boards and in the API - `isArchived` boolean, required — Whether the location is archived - `isRemote` boolean, nullable, required — Deprecated. Use workplaceType instead. - `address` object, nullable, required — The address for the location - `postalAddress` object, required — The postal address for the location - … - `parentLocationId` string, uuid, nullable, required — The unique identifier for the parent location hierarchy, if any - `type` 'Location' | 'LocationHierarchy', required — The type of the location component - `workplaceType` 'OnSite' | 'Hybrid' | 'Remote', nullable, required — The type of workplace - `extraData` object, nullable, required — Structured key-value information for your own use and reference. Do not store personally identifiable information in this field. - `compensation` JobCompensation - `compensationTiers` JobCompensationTier[], required — The compensation ranges that can be offered to applicants for this job - `id` string, uuid, required — The compensation tier's unique id - `title` string, nullable, required — A label that describes the entire range to applicants - `additionalInformation` string, nullable, required — Supplementary information about the compensation - `components` JobCompensationTierComponent[], required — The individual components that make up this compensation range - … - `tierSummary` string, nullable, required — A summary of the tier's components in the same format shown on job boards - `customFields` JobCustomField[] — Custom field values associated with the job - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean, required — Whether the custom field is private - `title` string, required — The title of the custom field - `value` union, required — The value of the custom field - boolean - number - string - string[] - object - … - object - … - object - … - object - … - `valueLabel` union — The human-readable label for select custom field values - string - string[] - `author` User - `id` string, uuid, required — The unique identifier for the user - `firstName` string, required — The user's first name - `lastName` string, required — The user's last name - `email` string, email, nullable, required — The user's email address - `globalRole` 'Organization Admin' | 'Elevated Access' | 'Limited Access' | 'External Recruiter', required — The user's global role in the organization - `isEnabled` boolean, required — Whether the user is enabled (not deactivated) - `updatedAt` string, required — The timestamp when the user was last updated (ISO 8601 format) - `managerId` string, uuid — The unique identifier for the user's manager - `customFields` CustomField[] — Custom fields associated with the user (only included when requested) - `id` string, uuid, required — The unique identifier for the custom field definition - `isPrivate` boolean, required — Whether the custom field is private - `title` string, required — The title of the custom field - `value` union, required — The value of the custom field - … - `valueLabel` union — The label of the custom field value. This is only present for value select custom fields. - … - `createdAt` string, required — The timestamp when the job was created - `updatedAt` string, required — The timestamp when the job was last updated - `openedAt` string, nullable — The timestamp when the job was opened - `closedAt` string, nullable — The timestamp when the job was closed - `interview` Interview - `id` string, uuid, required — The unique identifier for the interview - `title` string, required — The internal title of the interview - `externalTitle` string, required — The title of the interview shown to candidates - `type` 'Assessment' | 'Interview' | 'InterviewWithoutSchedule' | 'TakeHome' | 'Debrief', required — The interview definition type, such as Interview, TakeHome, or Debrief - `isArchived` boolean, required — Whether the interview is archived - `isDebrief` boolean, required — Whether the interview is a debrief - `isFeedbackRequired` boolean, required — Whether feedback is required for this interview - `isFeedbackRequested` boolean, required — Whether feedback is requested for this interview - `instructionsHtml` string, nullable — The interview instructions rendered as HTML - `instructionsPlain` string, nullable — The interview instructions rendered as plain text - `jobId` string, uuid, nullable — The unique identifier for the job associated with this interview, if any - `feedbackFormDefinitionId` string, uuid, required — The unique identifier for the feedback form definition used by this interview - ErrorResponse - `success` false, required - `errors` ErrorDetail[], required - `message` string, required - `parameter` string --- [API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)