v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Users

Retrieve the OAuth access token of a user

Fetch the corresponding OAuth access token for a user that has previously authenticated with a particular OAuth provider. For OAuth 2.0, if the access token has expired and we have a corresponding refresh token, the access token will be refreshed transparently the new one will be returned.

get/users/{user_id}/oauth_access_tokens/{provider}

Path parameters

user_idstring required

The ID of the user for which to retrieve the OAuth access token

providerstring required

The ID of the OAuth provider (e.g. oauth_google)

Query parameters

paginatedboolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

limitinteger

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offsetinteger

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Response

Success

object'oauth_access_token' required
external_account_idstring required

External account ID

provider_user_idstring required

The unique ID of the user in the external provider's system

tokenstring required

The access token

expires_atinteger nullable required

Unix timestamp of the access token expiration.

providerstring required

The ID of the provider

public_metadataobject required
labelstring nullable required
scopesstring[]

The list of scopes that the token is valid for. Only present for OAuth 2.0 tokens.

id_tokenstring

The ID token retrieved from the OIDC provider. Only present for OIDC-compliant OAuth 2.0 providers when available.

token_secretstring

The token secret. Only present for OAuth 1.0 tokens.