Skip to main content
GET
Get a sender email

Authorizations

X-API-KEY
string
header
required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY
string | null
Authorization
string | null
X-Workspace-Id
string | null

Path Parameters

sender_email_id
string
required

Response

Successful Response

data
SenderEmailResponse · object
required

A sender email address configured for the workspace.

Sender emails are used for candidate communications (invitations, nudges, reports). The id is referenced in posting configs as sender_email_id.

meta
Meta · object | null

Optional metadata. Shape varies by endpoint.