OAuth/OpenID userinfo endpoint

GET

/oauth/userinfo

curl --request GET \
  --url https://app.buildworkpro.com/api/v1/oauth/userinfo \
  --header 'Authorization: Bearer <token>'

• Production

Returns identity information about the resource owner authenticated by the presented access token. Authentication is the standard Authorization: Bearer header — both API keys (bwp_live_/bwp_test_) and OAuth access tokens (bwp_at_) are accepted. No scope is required to call this endpoint.

Authorizations

• bearerAuth
• oauth2

Responses

200

Identity claims for the resource owner

Media type application/json

object

sub

required

Stringified user id of the resource owner.

string

tenant_id

required

Tenant the access token is scoped to.

integer

email

required

Email address of the resource owner.

string format: email

name

required

firstName lastName, trimmed. Empty string when both names are missing — never null.

string

role

required

The user’s tenant role at the moment the request was authenticated.

string

scopes

required

The scopes carried by the presented access token.

Array<string>

Example

{
  "sub": "42",
  "tenant_id": 7,
  "email": "jane@example.com",
  "name": "Jane Doe",
  "role": "company_admin",
  "scopes": [
    "contacts:read",
    "leads:read"
  ]
}

401

Authentication missing, invalid, expired, or membership revoked

Media type application/problem+json

object

Example ^generated

{}