Team API

List team members

Browse the members linked to your business account.

GET/team_members

Overview

Read a paginated list of team members and their business roles. Use it to build a member picker, find returned user IDs, and inspect onboarding information before starting a notary workflow.

Before you start

Use the API key for the owning business account.

  1. Filter the role

    Narrow to notaries when building a direct-assignment picker.

  2. Read each page

    Follow has_next with positive page and limit values.

  3. Use stable IDs

    Store each returned member id rather than its position in the list.

Parameters

FieldRequirementDescription
role
string · query
OptionalFilter the business role, such as notary, pretagger, or admin.
email
string · query
OptionalCase-insensitive regex match against member email. This is not an exact-match-only filter.
page
integer · query
OptionalPage number, default 1. Send positive integers.
limit
integer · query
OptionalResults per page, default 25 and capped at 100. Send a positive value.

Request example

Use a server-side API key. Replace example IDs and values before using this request in an approved test environment.

curl --request GET \
  --url 'https://app.bluenotary.us/api/integrationsv2/team_members' \
  --header "Authorization: Bearer $BLUENOTARY_API_KEY"

Response

200 · Example success Illustrative values in the current response shape.

RESPONSE
{
  "data": [
    {
      "id": "69a100000000000000000204",
      "email": "notary@example.com",
      "role": "notary",
      "business_role": "notary",
      "onboarding_status": "complete",
      "name": "Avery Notary",
      "state": "Texas",
      "county": "Travis",
      "commission_expires_on": "2031-12-31T00:00:00.000Z",
      "created_at": "2030-01-15T14:00:00.000Z",
      "updated_at": "2030-01-15T14:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total_items": 1,
    "has_next": false
  }
}
  • Use pagination.has_next to decide whether to request another page.
  • A status filter is not supported by this operation. Do not send it even if an older schema lists it.
  • The handler does not establish a stable sort guarantee. Avoid treating page positions as permanent IDs.
  • Onboarding status and assignment approval are separate. A member list is not an availability calendar.

Errors & recovery

StatusWhat happenedWhat to do
401Authentication failedCheck that the API key is valid and unexpired.
403Business account unavailableCheck the owning business relationship and account permissions.

Explore the response

Response simulator

LOCAL EXAMPLE

Explore the example response without an API key. This does not send requests or validate your account configuration.

This example uses the resource ID shown in the endpoint path.

A filtered request

Use /team_members?role=notary&page=1&limit=25 to list the first page of notaries.

  • URL-encode query values, including email patterns.
  • Do not send a JSON body with the GET request.
  • Fields such as state, county, and commission_expires_on apply to notary records.

Keep building