Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
User Emails

List user emails

User emails are the email addresses attached to a Greenhouse user. A user can hold multiple addresses — typically one work email plus aliases or historical addresses — but only one is the primary, which Greenhouse uses for sign-in and notifications and is exposed as primary_email on the /v3/users resource. Use this endpoint to resolve a list of addresses back to users (e.g. matching candidate-attributed emails to interviewer calendars), or to audit which secondary aliases are verified. The primary email itself cannot be switched through Harvest; use POST /v3/user_emails to add secondaries.

get/v3/user_emails

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
user_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

emailstring[]

Return only user emails matching one of these addresses. Comma separated, case-insensitive exact match; useful for resolving a list of candidate-attributed emails back to Greenhouse users.

verifiedboolean

Return only verified (true) or unverified (false) user emails. Omit to include both.

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by when the verification email was last sent. Pass any combination of gte, lte, gt, lt as ISO-8601 date-times (e.g. verification_token_sent_at[gte]=2026-01-01T00:00:00Z). Only matches rows that have an outstanding verification.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
user_idinteger

Id of the user this email belongs to. References a /v3/users row.

emailstring

The email address. Stored case-insensitively and unique across all users in Greenhouse; an email can be attached to only one user at a time.

verifiedboolean

Whether the user has confirmed ownership of this address. Only verified emails can be used to send mail on behalf of the user or to match interviewer calendars.

verification_token_sent_atstring date-time nullable

When the most recent verification email was sent, as an ISO 8601 timestamp. Null if no verification email is outstanding (the address is already verified, or verification was never requested).