admin

Get account for admin

Changed on
post/v1/admin.getAccount

Request

  • Base URL: https://api.steamsets.com
  • URL: https://api.steamsets.com/v1/admin.getAccount
  • Auth: HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

Example request

{
  "$schema": "https://api.steamsets.com/schemas/AccountSearch.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

avatarstring required

The avatar of the account

blockedLoginsinteger required

How many sign-ins account.login refused while the restriction was in force

citystring nullable required

The city of the account

countrystring nullable required

The country code of the account

customDonationsinteger required

The staff-granted donation total in cents

donationsinteger required

The Patreon-reported donation total in cents

emailstring email nullable required

The email of the account

hiddenboolean required

Whether the account has hidden itself from steamsets leaderboards

lastBlockedLoginAtstring date-time nullable required

When account.login last refused a sign-in

namestring required

The name of the account

nameEffectstring required

The name effect, none when the account has none

notestring nullable required

The staff note on this account, if any

noteAuthorstring nullable required

Name of the staff member who last wrote the note

noteUpdatedAtstring date-time nullable required

When the staff note was last written

privacy'private' | 'public' | 'friends_only' required

The privacy of the account

regionstring nullable required

The region of the account

restrictedboolean required

Whether staff has hidden this account site-wide and locked it out of login

restrictedAtstring date-time nullable required

When the restriction was applied

restrictedByNamestring nullable required

Name of the staff member who applied the restriction

restrictionReasonstring nullable required

The staff-facing reason for the restriction, if any

statestring nullable required

The state of the account

themeColorstring nullable required

The profile theme color as #RRGGBB, or null when the account has none

vanitystring nullable required

The vanity of the account

Example response

{
  "$schema": "https://api.steamsets.com/schemas/V1AdminGetAccountResponseBody.json",
  "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9.jpg",
  "city": "Bad Krozingen",
  "connections": [
    {
      "avatar": "https://cdn.cloudflare.steamstatic.com/steamcommunity/public/images/avatars/f1/f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9.jpg",
      "connectionId": "123456",
      "externalId": "123456",
      "failed": true,
      "hide": true,
      "name": "steamsets",
      "provider": "discord",
      "verified": true
    }
  ],
  "country": "Germany",
  "customDonations": 2500,
  "developerApps": [
    {
      "analytics": {
        "last24Hours": {
          "failedRequests": 358,
          "outcomeBreakdown": [
            {
              "count": 9876,
              "outcome": "VALID"
            }
          ],
          "successRate": 96.5,
          "successfulRequests": 9876,
          "totalRequests": 10234
        },
        "timeSeries": {
          "hourly": [
            {
              "count": 423,
              "outcome": "VALID",
              "time": "2024-01-15T00:00:00.000Z"
            }
          ]
        }
      },
      "apiKey": "null",
      "createdAt": "2023-01-01T00:00:00Z",
      "description": "My App Description",
      "environment": "production",
      "id": "key_123456",
      "keyId": "key_123456",
      "name": "My App"
    }
  ],
  "donations": 1000,
  "email": "steamsets@example.com",
  "locationUpdates": [
    {
      "city": {
        "new": "steamsets",
        "old": "steamsets"
      },
      "countryCode": {
        "new": "steamsets",
        "old": "steamsets"
      },
      "countryName": {
        "new": "steamsets",
        "old": "steamsets"
      },
      "region": {
        "new": "steamsets",
        "old": "steamsets"
      },
      "state": {
        "new": "steamsets",
        "old": "steamsets"
      },
      "updatedAt": "2023-01-01T00:00:00Z"
    }
  ],
  "name": "steamsets",
  "nameEffect": "rainbow",
  "nameUpdates": [
    {
      "name": {
        "new": "steamsets",
        "old": "steamsets"
      },
      "updatedAt": "2023-01-01T00:00:00Z"
    }
  ],
  "privacy": "public",
  "region": "Europe",
  "resources": [
    {
      "inherited": {
        "role": "diamond",
        "value": "600000"
      },
      "otherRoles": [
        {
          "role": "donator",
          "value": "2500"
        }
      ],
      "override": {
        "value": "60000"
      },
      "role": "diamond",
      "source": "role",
      "value": "600000"
    }
  ],
  "sessions": [
    {
      "createdAt": "2023-01-01T00:00:00Z",
      "expiresAt": "2023-01-01T00:00:00Z",
      "ip": "127.0.0.1",
      "lastSeen": "2023-01-01T00:00:00Z",
      "location": {
        "city": "Berlin",
        "countryCode": "DE",
        "countryName": "Germany",
        "region": "Berlin"
      },
      "sessionId": "123456",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
    }
  ],
  "state": "Baden-Wurttemberg",
  "themeColor": "#FF5733",
  "tierOverride": {
    "createdBy": 1216167888,
    "reason": "PayPal donation",
    "tier": "tier_2"
  },
  "vanity": "steamsets",
  "vanityUpdates": [
    {
      "updatedAt": "2023-01-01T00:00:00Z",
      "vanity": {
        "new": "steamsets",
        "old": "steamsets"
      }
    }
  ],
  "visibilityUpdates": [
    {
      "kind": "profile",
      "updatedAt": "2023-01-01T00:00:00Z",
      "visibility": {
        "new": "steamsets",
        "old": "steamsets"
      }
    }
  ]
}

Changes

  • 727871ddcbb7Revision changes
    • info

      removed the kick enum value from the // response property for the response status

  • cab8b3a076d5Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status