Skip to main content
Required scopes: agency_roles:read
Rate limit: default tier, 120 requests per minute per key
Returns one recruiter-facing role brief using the selected approved agency member’s permissions. The role need not be in that member’s approved-role list. Missing and inaccessible roles both return 404. Recruiter and company information is explicitly allowlisted; confidential/stealth views and announcement recipients are enforced server-side. Company logos and hiring-manager contact objects are excluded. Candidate calibration examples and application histories are excluded. includeIntakeTranscripts defaults to false: the field is omitted and transcripts are not loaded. When true, the same agency_roles:read scope includes only permitted transcripts selected by the role’s intake settings. Hidden intake, restricted recruiters, private calls, unrelated-role calls, and unrevealed stealth identities do not unlock transcripts. Requested transcripts with no readable text return an empty array; summaries never substitute for transcript text. Recording, playback, and media-download URLs are not returned. Embedded links are omitted from prose. Candidate salary/equity and company funding are included where visible. Structured recruiter-payment fields are excluded, but otherwise permitted prose is not screened for incidental payment mentions. Unknown or withheld scalar fields are null and collections are empty. updatedAt accounts for returned role, company, and guidance sources; each transcript has its own updatedAt. This API is independent of the talent network.

​
Path parameters

​
string
required
Constraints: min length 1, max length 128.

​
Query parameters

​
string
required
Email of a currently approved member of the authenticated agency. Selects that member’s permissions; it does not authenticate the person holding the key. Constraints: format email, max length 254.
​
string
Use true or false. Defaults to false. True includes only the intake transcripts permitted by the role’s visibility and intake-selection rules. Allowed values: true, false.

​
Response

​
string
required
​
string
required
​
object
required
​
string
required
Allowed values: ACTIVE, PAUSED, CLOSED.
​
string[]
required
​
string | null
required
Allowed values: REMOTE, HYBRID, ON_SITE.
​
object | null
required
Annual candidate base salary in whole currency units, without conversion. Null currency is unknown, not implicitly USD.
​
string
required
Constraints: format date-time.
​
string | null
required
​
string[]
required
​
string[]
required
​
object
required
​
string | null
required
​
string | null
required
​
string | null
required
​
string | null
required
​
string | null
required
​
string | null
required
​
string | null
required
​
string | null
required
Constraints: format date-time.
​
object[]
required
​
object[]
required
​
object[]
required
​
object
required
​
object
required
​
object
required
​
object[]
Absent unless explicitly requested. Empty when no selected, permitted transcript text is available. Never contains recording or playback URLs.