Skip to main content
POST
/
v2
/
auth
/
sign-in
Sign in
curl --request POST \
  --url https://rest.forestreet.com/v2/auth/sign-in \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "email": "jsmith@example.com",
  "password": "<string>"
}'
{
  "message": "<string>",
  "accessToken": "<string>",
  "refreshToken": "<string>",
  "idToken": "<string>",
  "expiresIn": 123,
  "checksum": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Body

application/json
email
string<email>
required

Email address of the user.

password
string
required

Password of the user.

Minimum length: 1

Response

User signed in successfully

message
string
required

Message from the server.

accessToken
string
required

Access token for the user.

refreshToken
string
required

Refresh token for the user.

idToken
string
required

Id token for the user.

expiresIn
number
required

Expires in for the user.

checksum
string
required

Checksum for the tokens.