Skip to main content
POST
/
v1
/
account.getSettings
Get account settings
curl --request POST \
  --url https://api.steamsets.com/v1/account.getSettings \
  --header 'Authorization: Bearer <token>'
{
  "chosenRole": {
    "role": "user",
    "tier": "<string>"
  },
  "connections": [
    {
      "avatar": "<string>",
      "connectionId": "<string>",
      "externalId": "<string>",
      "failed": true,
      "hide": true,
      "name": "<string>",
      "provider": "discord",
      "verified": true
    }
  ],
  "developerApps": [
    {
      "apiKey": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "environment": "production",
      "id": "<string>",
      "keyId": "<string>",
      "name": "<string>",
      "analytics": {
        "last24Hours": {
          "failedRequests": 1,
          "outcomeBreakdown": [
            {
              "count": 1,
              "outcome": "VALID"
            }
          ],
          "successRate": 123,
          "successfulRequests": 1,
          "totalRequests": 1
        },
        "timeSeries": {
          "hourly": [
            {
              "count": 1,
              "outcome": "<string>",
              "time": "2023-11-07T05:31:56Z"
            }
          ]
        }
      }
    }
  ],
  "email": "[email protected]",
  "emailVerifiedAt": "2023-11-07T05:31:56Z",
  "hidden": true,
  "images": [
    {
      "active": true,
      "fileName": "<string>",
      "imageId": "<string>",
      "imageType": "avatar"
    }
  ],
  "language": "<string>",
  "privacy": "public",
  "sessions": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "ip": "<string>",
      "lastSeen": "2023-11-07T05:31:56Z",
      "sessionId": "<string>",
      "userAgent": "<string>"
    }
  ],
  "subscribed": true,
  "vanity": "<string>",
  "vanityAnalytics": {
    "clicks": 123
  },
  "$schema": "<string>",
  "analytics": {
    "last24Hours": {
      "failedRequests": 1,
      "outcomeBreakdown": [
        {
          "count": 1,
          "outcome": "VALID"
        }
      ],
      "successRate": 123,
      "successfulRequests": 1,
      "totalRequests": 1
    },
    "timeSeries": {
      "hourly": [
        {
          "count": 1,
          "outcome": "<string>",
          "time": "2023-11-07T05:31:56Z"
        }
      ]
    }
  }
}
This endpoint is not intended for public use and requires user authentication

​
Authentication Required

This endpoint requires an active user session and cannot be accessed via API keys. It’s designed for authenticated user interactions within the web application.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

OK

​
chosenRole
object
required

The chosen role the account has

​
connections
object[] | null
required

The connections the account has

​
developerApps
object[] | null
required

The developer apps the account has

​
email
string<email>
required

The email the account is using

Example:

"[email protected]"

​
emailVerifiedAt
string<date-time> | null
required

The time the email was verified

Example:

"2023-01-01T00:00:00Z"

​
hidden
boolean
required

Whether the account is hidden in the leaderboards

Example:

true

​
images
object[] | null
required
deprecated

The images the account has

​
language
string
required

The language the account is using

Example:

"en"

​
privacy
enum<string>
required

The privacy of the account

Available options:
public,
private,
friends_only
Example:

"public"

​
sessions
object[] | null
required

The sessions the account has

​
subscribed
boolean
required

Whether the account is subscribed to marketing emails

​
vanity
string
required

The vanity the account is using

Example:

"flo"

​
vanityAnalytics
object
required

The analytics for the vanity

​
$schema
string<uri>

A URL to the JSON Schema for this object.

Example:

"https://api.steamsets.com/schemas/V1AccountGetSettingsBody.json"

​
analytics
object

Aggregated analytics for all API keys of this account