Authentication
Generated on 18 Mar 2026
https://api.paperspace.com/v1
Endpoints
GET Get the current session
/auth/session
Authorizations:
BearerAuth
An API key or access token
Get the current session. If a user is not logged in, this will be null. Otherwise, it will contain the current team and user.
Request: /auth/session
curl -X GET \
-H "Authorization: Bearer $API_TOKEN" \
"https://api.paperspace.com/v1/auth/session"Responses
200
Successful response
application/json
team
required
Show child properties
analyticsId
required
An internal, numeric ID for the team
id
required
A unique ID for the team
isPrivate
required
Whether the team is private or not
maxMachines
required
The maximum number of machines
namespace
required
The namespace for the team
user
required
Show child properties
analyticsId
required
An internal, numeric ID for the user
dtConfirmed
required Nullable
The date the account was confirmed
dtCreated
required
The date the user was created
email
required
The user's email address
firstName
required Nullable
The user's first name
id
required
A unique ID for the user
isPasswordAuthEnabled
required
Whether the user has a password set
isPhoneVerified
required
Whether the user's phone number has been verified
isQrCodeBasedMfaConfirmed
required
Whether the user has a QR code based MFA confirmed
isQrCodeBasedMfaEnabled
required
Whether the user has a QR code based MFA enabled
lastName
required Nullable
The user's last name
metadata
required
Metadata about the user
Show child properties
coreSurvey
optional Nullable
Core survey question-answer pairs
Show child properties
(additional properties)
optional
Additional properties are allowed.
gradientSurvey
optional Nullable
Gradient survey question-answer pairs
Show child properties
(additional properties)
optional
Additional properties are allowed.
graphcoreTermsAccepted
optional
Whether the user has accepted the Graphcore terms of service
tags
optional Nullable
Tags for the user
preferences
optional Nullable
The user's preferences
Show child properties
defaultProduct
optional Nullable
defaultTeamId
optional Nullable
disableHotkeys
optional Nullable
fontSize
optional Nullable
theme
optional Nullable
teamMemberships
required
The teams this user is a member of
Show child properties
isAdmin
required
Whether the user is an admin of the team
isOwner
required
Whether the user is the owner of the team
team
required
The team the user is a member of
Show child properties
dtCreated
required
The date the team was created
id
required
The ID of the team
isUserTeam
required
Whether the team is the user's team
name
required
The name of the team
namespace
required
The namespace of the team
publicProfileImageUrl
optional Nullable
The URL of the team's profile image.
default
Error response
application/json
code
required
details
optional
message
required
Response
{
"team": {
"analyticsId": 0,
"id": "string",
"isPrivate": true,
"maxMachines": 0,
"namespace": "string"
},
"user": {
"analyticsId": 0,
"dtConfirmed": "2019-08-24T14:15:22Z",
"dtCreated": "2019-08-24T14:15:22Z",
"email": "string",
"firstName": "string",
"id": "string",
"isPasswordAuthEnabled": true,
"isPhoneVerified": true,
"isQrCodeBasedMfaConfirmed": true,
"isQrCodeBasedMfaEnabled": true,
"lastName": "string",
"metadata": {
"graphcoreTermsAccepted": false,
"tags": "string"
},
"preferences": {
"defaultProduct": "string",
"defaultTeamId": "string",
"disableHotkeys": true,
"fontSize": 0,
"theme": "light"
},
"teamMemberships": []
}
}{
"code": "string",
"message": "string"
}