The Profile object

The person who connected your app with OAuth, and the grant itself.

Attributes

userUserRequired

Show child attributes

idUUIDRequired

Unique ID of the user.

namestringRequired

Display name.

rolestringRequired

The user’s role in the organization.

organizationOrganizationRequired

Show child attributes

idUUIDRequired

Stable organization UUID.

namestringRequired

Organization display name.

appAppRequired

A registered app.

Show child attributes

client_idstringRequired

Your app’s OAuth client ID.

namestringRequired

Your app’s name as users and staff see it.

scopesarray of stringRequired

Scopes the user granted your app.

expires_attimestampRequired

When this grant reaches its 12-month limit and the user must approve your app again.

Endpoints

Method	Path	Endpoint
GET	`/me`	Retrieve the profile

The Profile object


{
  "user": {
    "id": "8b9c2d2f-6b1a-44f4-a7b1-0d6d3f2d6f55",
    "name": "Alex Example",
    "role": "member"
  },
  "organization": {
    "id": "6db1e3f5-9b7f-4f2b-8be1-0f1e1d7d7d8c",
    "name": "Example Clinic"
  },
  "app": {
    "client_id": "bt_client_7Hq2mX9aLk",
    "name": "Acme EHR Assistant"
  },
  "scopes": [
    "messages.read",
    "offline_access"
  ],
  "expires_at": "2027-09-21T15:04:05Z"
}