Skip to main content
GET
/
oauth-connections
/
{name}
JavaScript
import Reminix from '@reminix/sdk';

const client = new Reminix({
  apiKey: process.env['REMINIX_API_KEY'], // This is the default and can be omitted
});

const oauthConnection = await client.oauthConnections.retrieve('name');

console.log(oauthConnection.id);
{
  "id": "conn_abc123",
  "providerId": "prov_xyz",
  "providerName": "Google",
  "providerSlug": "google",
  "slug": "google",
  "label": null,
  "tokenType": "Bearer",
  "scopes": "calendar.readonly email",
  "status": "active",
  "isDefault": true,
  "accountIdentifier": "user@example.com",
  "lastUsedAt": "2024-01-15T10:30:00Z",
  "createdAt": "2024-01-10T08:00:00Z"
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Path Parameters

name
string
required

Connection name (slug)

Response

OAuth connection details

id
string
required

Connection ID

providerId
string
required

Provider ID

providerName
string
required

Provider display name

providerSlug
string
required

Provider slug

slug
string | null
required

Connection name (slug)

label
string | null
required

Optional display label

tokenType
string
required

Token type (e.g. Bearer)

scopes
string | null
required

Granted scopes

status
string
required

Connection status

isDefault
boolean
required

Whether this is the default connection for its provider

accountIdentifier
string | null
required

Account identifier (e.g. email)

lastUsedAt
string | null
required

Last used timestamp

createdAt
string
required

Creation timestamp