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

const client = new Hyperspell({
  apiKey: 'My API Key',
});

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": [
    "collections"
  ],
  "installed_integrations": [
    "collections"
  ],
  "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
object
required

The Hyperspell app's id this user belongs to

​
available_integrations
enum<string>[]
required

All integrations available for the app

​
installed_integrations
enum<string>[]
required

All integrations installed for the user

​
token_expiration
string<date-time> | null
required

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

⌘I