Retrieve an email recipient

​

Returns the email recipient with this person_id, the id audits show in people[].person_id. Returns 404 NOT_FOUND when your organization has no email recipient with this id; another organization's id and a deleted recipient return 404 too. A person_id that does not belong to an email recipient returns 404 as well. An id that is not a UUID returns 400 VALIDATION_ERROR.

GET /v2/email_recipients/{person_id} can take a few seconds to reflect a create, change or delete; until then you can get 404 or the previous version.

Path Parameters

  • person_id
    Type: stringFormat: uuid
    required

    The recipient's person_id, the same id audits show in people[].person_id.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v2/email_recipients/{person_id}
import BrelliumClient from '@brellium/api-client';

const client = new BrelliumClient({
  oAuth2: process.env['BRELLIUM_ACCESS_TOKEN'], // defaults to the BRELLIUM_ACCESS_TOKEN env var
});

const emailRecipient = await client.emailRecipients.retrieve('2a1b0c9d-8e7f-4a6b-9c5d-4e3f2a1b0c9d');

console.log(emailRecipient);

{
  "person_id": "2a1b0c9d-8e7f-4a6b-9c5d-4e3f2a1b0c9d",
  "object": "email_recipient",
  "first_name": "Jordan",
  "last_name": "Rivera",
  "email": "jordan.rivera@clinic.example",
  "metadata": {
    "roster_team": "North clinic"
  },
  "created_at": "2026-09-01T12:00:00.000Z",
  "updated_at": "2026-09-01T12:00:00.000Z"
}

The email recipient.

Previous
Create an email recipient
Next
Update an email recipient