Skip to main content
GET
/
auth
/
me
JavaScript
import Hyperspell from '@hyperspell/hyperspell';

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

const response = await client.auth.me();

console.log(response.id);
{
  "id": "<string>",
  "app": {
    "id": "<string>",
    "name": "<string>",
    "icon_url": "<string>",
    "redirect_url": "<string>"
  },
  "available_integrations": [],
  "installed_integrations": [],
  "token_expiration": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Response

200 - application/json

Successful Response

​
id
string
required

The user's id

​
app
AppInfo · object
required

The Hyperspell app's id this user belongs to

​
available_integrations
enum<string>[]
required

All integrations available for the app

Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
dropbox,
github,
google_drive,
vault,
web_crawler,
trace,
microsoft_teams,
gmail_actions,
granola,
fathom,
linear,
hubspot,
salesforce,
coda
​
installed_integrations
enum<string>[]
required

All integrations installed for the user

Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
dropbox,
github,
google_drive,
vault,
web_crawler,
trace,
microsoft_teams,
gmail_actions,
granola,
fathom,
linear,
hubspot,
salesforce,
coda
​
token_expiration
string<date-time> | null
required

The expiration time of the user token used to make the request