About me

Get the current user’s information and their access to teams and collections.

This endpoint returns the user’s authentication metadata, including their ID and email, as well as the IDs of teams and collections they have access to.

GET /v2/users/me

About me

cURL

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

200

{
  "sub": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "identities": [
    {
      "userId": "<string>",
      "providerName": "<string>",
      "providerType": "<string>",
      "issuer": "<string>",
      "primary": true,
      "dateCreated": 123
    }
  ],
  "customAttributes": {
    "promoGroupName": "<string>",
    "isNewUser": true,
    "isTermsAgreed": true,
    "theme": "<string>",
    "ailsaPreferences": {
      "activeWidgets": [
        "<string>"
      ],
      "isWidgetsHidden": true,
      "tableShownColumns": [
        "<string>"
      ]
    },
    "internalPermissions": []
  }
}

Authorizations

apiKeyAuthbearerAuthsessionIdQuery

x-api-key · string · header · required

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

Response

200

application/json

Current user information

sub · string · required

authenticationMethod · enum<string> · required

Available options: token, apiKey, specialToken

email · string

firstName · string

lastName · string

identities · object[]

Show child attributes

userStatus · enum<string>

Available options: UNCONFIRMED, CONFIRMED, EXTERNAL_PROVIDER, RESET_REQUIRED, FORCE_CHANGE_PASSWORD

customAttributes · object

Show child attributes