Get session ID

Get session ID

curl --request GET \
  --url https://rest.forestreet.com/v2/auth/session \
  --header 'x-api-key: <api-key>'

{
  "message": "<string>",
  "accessToken": "<string>",
  "refreshToken": "<string>",
  "expiresIn": 123,
  "expiresAt": 123
}

GET

auth

session

Get session ID

curl --request GET \
  --url https://rest.forestreet.com/v2/auth/session \
  --header 'x-api-key: <api-key>'

{
  "message": "<string>",
  "accessToken": "<string>",
  "refreshToken": "<string>",
  "expiresIn": 123,
  "expiresAt": 123
}

x-api-key

string

header

required

Pass a static API key for every request, provided by your customer support.

x-api-key

string

required

API key for authentication.

Minimum string length: 1

Session created successfully

message

string

required

Message from the server.

accessToken

string

required

Access token for the user.

refreshToken

string

required

Refresh token for the user.

expiresIn

number

required

Expires duration for the access token.

expiresAt

number

required

Expires timestamp for the access token.

⌘I