Users
Retrieve a User's Email Address
Retrieves detailed information about a specific email address linked to the user. Only the authenticated user can view their own email addresses.
Query Parameters
- resend_confirmation=true -- Optional. If the email address is unconfirmed, this query param will resend the confirmation email.
Returns
Returns a JSON object with a data key containing the details of the requested email address.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.
get/users/{user_id}/settings/emails/{email_id}/
Path parameters
user_idstring required
The unique identifier of the user. Example: abc123
email_idstring required
The unique identifier of the email address (either a hashed ID or unconfirmed token). Example: 1a2b3c
Query parameters
resend_confirmationboolean
If true, resend a confirmation email to the unconfirmed address (if applicable).
Response
Successfully retrieved the email address.
Example response
{
"data": {
"type": "users",
"id": "{user_id}",
"attributes": {
"full_name": "Casey M. Rollins",
"middle_names": "Marie",
"social": {
"github": [
"https://github.com/caseyrollins"
],
"twitter": [
"https://twitter.com/crollins"
]
},
"employment": [
{
"title": "Data Scientist",
"institution": "Open Science Framework",
"department": "Engineering",
"startYear": 2018,
"startMonth": 5,
"ongoing": true
}
],
"education": [
{
"degree": "MS in Computer Science",
"institution": "University of Somewhere",
"department": "Computer Science",
"startYear": 2014,
"startMonth": 9,
"endYear": 2016,
"endMonth": 6,
"ongoing": false
}
]
}
}
}