Get a sender email

Returns a single sender email address by ID.

GET /api/v2/sender-emails/{sender_email_id}

Get a sender email

cURL

curl --request GET \
  --url https://api.heymilo.ai/api/v2/sender-emails/{sender_email_id} \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "email_prefix": "<string>",
    "domain": "<string>",
    "full_email": "<string>",
    "domain_id": "<string>",
    "created_at": 123,
    "object": "sender_email"
  },
  "meta": {}
}

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

200

application/json

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.

Show child attributes

meta · Meta · object

Optional metadata. Shape varies by endpoint.