Skip to main content
GET
Read a role's recruiting brief

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

roleId
string
required

id from listAgencyRoles or searchAgencyRoles row. Never guess one.

Required string length: 1 - 128

Query Parameters

recruiterEmail
string<email>
required

Email of currently approved member of your agency, e.g. jane@agency.com. Results use that member's permissions; does not authenticate key holder. Unknown, other-agency, or unapproved member answers 403.

Maximum string length: 254
includeIntakeTranscripts

Include role's intake call transcripts. Default false. Only transcripts this member may read returned.

Available options:
true,
false

Response

200 - application/json

Success

id
string
required
title
string
required
company
object
required
status
enum<string>
required
Available options:
ACTIVE,
PAUSED,
CLOSED
locations
string[]
required
workplaceType
enum<string> | null
required
Available options:
REMOTE,
HYBRID,
ON_SITE
baseSalary
object | null
required

Annual candidate base salary, whole currency units, no conversion. Null currency means unknown, not USD.

updatedAt
string<date-time>
required
description
string | null
required
responsibilities
string[]
required
techStack
string[]
required
experience
object
required
visaInformation
string | null
required
equity
string | null
required
salaryDetails
string | null
required
positionExplanation
string | null
required
hiringGoals
string | null
required
workplaceDetails
string | null
required
employmentType
string | null
required
postedAt
string<date-time> | null
required
requirements
object[]
required
interviewStages
object[]
required
submissionQuestions
object[]
required
recruitingGuidance
object
required
candidateTargeting
object
required
additionalContext
object
required
intakeTranscripts
object[]

Absent unless requested. Empty when no selected, permitted transcript text. Never has recording or playback URLs.