Skip to main content
GET
/
v2
/
users
/
me
About me
curl --request GET \
  --url https://rest.forestreet.com/v2/users/me \
  --header 'x-api-key: <api-key>'
{
  "sub": "<string>",
  "authenticationMethod": "token",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "identities": [
    {
      "userId": "<string>",
      "providerName": "<string>",
      "providerType": "<string>",
      "issuer": "<string>",
      "primary": true,
      "dateCreated": 123
    }
  ],
  "userStatus": "UNCONFIRMED",
  "customAttributes": {
    "promoGroupName": "<string>",
    "isNewUser": true,
    "isTermsAgreed": true,
    "theme": "<string>",
    "ailsaPreferences": {
      "activeWidgets": [
        "<string>"
      ],
      "isWidgetsHidden": true,
      "tableShownColumns": [
        "<string>"
      ]
    },
    "internalPermissions": [
      "user.admin"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.forestreet.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

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

Response

Current user information

​
sub
string
required
​
authenticationMethod
enum<string>
required
Available options:
token,
apiKey,
specialToken
​
email
string
​
firstName
string
​
lastName
string
​
identities
object[]
​
userStatus
enum<string>
Available options:
UNCONFIRMED,
CONFIRMED,
EXTERNAL_PROVIDER,
RESET_REQUIRED,
FORCE_CHANGE_PASSWORD
​
customAttributes
object