v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Users

List User Email Addresses

Retrieves a list of all confirmed and unconfirmed email addresses associated with the user. The authenticated user can view their own email addresses.

Returns

Returns a JSON object with a data key containing a list of email addresses associated with the user.

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/

Path parameters

user_idstring required

The unique identifier of the user whose emails are being listed. Example: abc123

Response

A list of confirmed and unconfirmed email addresses for the user.

Example response

{
  "data": [
    {
      "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
            }
          ]
        }
      }
    }
  ]
}