List email recipients

​

Returns your organization's email recipients, newest first. Deleted recipients are left out. An email recipient is a person named on your audits, such as a provider, with the email address that receives their audit result emails. Audits show the recipient's person_id in people[].person_id.

Filter by email (ignoring case) or by created_after and created_before. Repeat person_id for specific recipients; unknown ids and other organizations' ids are left out.

Page with limit, starting_after and ending_before; include_total=true adds the number of matches. A deleted recipient's id still works as a cursor, so a sync that deletes recipients as it pages still reaches the last page. As a cursor, an unknown id or another organization's id returns an empty page.

Lists can take a few seconds to include a new or changed recipient.

Query Parameters

  • limit
    Type: integer
    min:  
    1
    max:  
    100

    The number of records per page, from 1 to 100. The default is 20.

  • starting_after
    Type: stringFormat: uuid

    Return the records after this id. To fetch the next page, send the id of the last record on your current page.

  • ending_before
    Type: stringFormat: uuid

    Return the records before this id. To fetch the previous page, send the id of the first record on your current page.

  • include_total
    Type: string

    true adds total_count to the response. Counting slows the request, so leave it off when you don't need it.

  • person_id

    Return only the records with these ids. To send more than one id, repeat the parameter (?person_id=<id>&person_id=<id>) or separate the ids with commas (?person_id=<id>,<id>).

  • email
    Type: string

    Return only recipients with this exact email address, ignoring case. Older recipients can share an address, so allow for more than one match.

  • created_after
    Type: stringFormat: date-time

    Return only recipients created at or after this time (RFC 3339 in UTC, ending in Z).

  • created_before
    Type: stringFormat: date-time

    Return only recipients created at or before this time (RFC 3339 in UTC, ending in Z).

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v2/email_recipients
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 emailRecipients = await client.emailRecipients.list({
  limit: 20,
});

console.log(emailRecipients);

{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "total_count": 342
}

A page of email recipients.

Previous
Email recipients
Next
Create an email recipient