Team API

Get a team member

Read one linked team member and their onboarding details.

GET/team_members/{team_member_id}

Overview

Retrieve a member by the BlueNotary user ID. The account must have the invited business relationship with that user. The endpoint returns member information, not a notary availability reservation.

Before you start

The member must be linked to the owning business administrator.

  1. Use the returned ID

    Resolve the member from your stored relationship record.

  2. Inspect role and onboarding

    Display relevant setup information to an administrator.

  3. Check eligibility separately

    Confirm the notary is eligible before direct assignment.

Parameters

FieldRequirementDescription
team_member_id
string · path
RequiredThe user_data.id from invitation or id from a team listing. Do not substitute vendor_user_id, email, or a relationship ID.

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/YOUR_TEAM_MEMBER_ID' \
  --header "Authorization: Bearer $BLUENOTARY_API_KEY"

Response

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

RESPONSE
{
  "id": "69a100000000000000000204",
  "email": "notary@example.com",
  "role": "notary",
  "business_role": "notary",
  "onboarding_status": "complete",
  "name": "Avery Notary",
  "created_at": "2030-01-15T14:00:00.000Z",
  "updated_at": "2030-01-15T14:00:00.000Z",
  "state": "Texas",
  "county": "Travis",
  "commission_expires_on": "2031-12-31T00:00:00.000Z"
}
  • Notary-specific fields appear only for notary business roles.
  • Commission expiry output can be an ISO timestamp while invitation input uses a YYYY-MM-DD date.
  • Do not infer approval from onboarding_status alone.
  • Invalid ID syntax is rejected by parameter validation before the handler.

Errors & recovery

StatusWhat happenedWhat to do
404Member or invited relationship not foundUse the returned user ID and confirm the member is linked to this account.
401Authentication failedCheck the API key.

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.

Keep building