---
title: "Get account for admin"
method: POST
path: "/v1/admin.getAccount"
tags: ["admin"]
---

# Get account for admin

`POST /v1/admin.getAccount`

## Request body

- AccountSearch
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `id` IDSearch
    - `accountId` integer — Account ID to search for
    - `steamId64` string — SteamID64 to search for
  - `vanity` VanitySearch
    - `type` 'steam' | 'internal', required — Which type of vanity to search for
    - `value` string, required — Vanity to search for

## Response `200`

OK

- V1AdminGetAccountResponseBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `avatar` string, required — The avatar of the account
  - `city` string, nullable, required — The city of the account
  - `connections` Connection[], nullable, required — The connections the account has
    - `avatar` string, required — The avatar of the connected account
    - `connectionId` string, required — The public id of the connection
    - `externalId` string, required — The external id of the connected account
    - `failed` boolean, required — Whether the connection has failed to refresh or not
    - `hide` boolean, required — Whether the connection should be hidden or not
    - `name` string, required — The name of the connected account
    - `provider` 'discord' | 'patreon' | 'kick' | 'reddit' | 'twitch' | 'youtube' | 'x' | 'domain', required — The provider to connect with
    - `verified` boolean, required — Whether the connection has been verified or not
  - `country` string, nullable, required — The country code of the account
  - `customDonations` integer, required — The staff-granted donation total in cents
  - `developerApps` DeveloperApp[], nullable, required — The developer apps the account has
    - `analytics` DeveloperAppAnalytics
      - `last24Hours` DeveloperAppAnalyticsLast24Hours, required
        - `failedRequests` integer, required — Number of failed requests (non-VALID outcomes)
        - `outcomeBreakdown` DeveloperAppAnalyticsOutcome[], nullable, required — Breakdown of requests by outcome
          - `count` integer, required — The number of verifications with this outcome
          - `outcome` 'VALID' | 'RATE_LIMITED' | 'INVALID' | 'EXPIRED' | 'DISABLED' | 'INSUFFICIENT_PERMISSIONS' | 'FORBIDDEN' | 'USAGE_EXCEEDED', required — The outcome of the verification
        - `successRate` number, double, required — Success rate as a percentage
        - `successfulRequests` integer, required — Number of successful requests (VALID outcome)
        - `totalRequests` integer, required — Total number of requests in the last 24 hours
      - `timeSeries` DeveloperAppAnalyticsTimeSeries, required
        - `hourly` DeveloperAppAnalyticsTimeSeriesPoint[], nullable, required — Hourly time series data for the last 24 hours
          - `count` integer, required — The number of verifications at this time
          - `outcome` string, required — The outcome of the verifications
          - `time` string, date-time, required — The timestamp of the data point
    - `apiKey` string, nullable, required — The api key (deprecated, always null for security)
    - `createdAt` string, date-time, required — When the app was created
    - `description` string, required — The description of the developer app
    - `environment` 'production' | 'development' | 'staging', required — The environment of the developer app
    - `id` string, required — The id of the developer app (same as keyId for backwards compatibility)
    - `keyId` string, required — The Unkey key ID
    - `name` string, required — The name of the developer app
  - `donations` integer, required — The Patreon-reported donation total in cents
  - `email` string, email, nullable, required — The email of the account
  - `hidden` boolean, required — Whether the account has hidden itself from steamsets leaderboards
  - `locationUpdates` V1AccountLocationUpdate[], nullable, required — The location updates the account has
    - `city` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry
    - `countryCode` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry
    - `countryName` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry
    - `region` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry
    - `state` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry
    - `updatedAt` string, date-time, required — The time the location was updated
  - `name` string, required — The name of the account
  - `nameUpdates` V1AccountNameUpdate[], nullable, required — The name updates the account has
    - `name` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry
    - `updatedAt` string, date-time, required — The time the name was updated
  - `note` string, nullable, required — The staff note on this account, if any
  - `noteAuthor` string, nullable, required — Name of the staff member who last wrote the note
  - `noteUpdatedAt` string, date-time, nullable, required — When the staff note was last written
  - `privacy` 'private' | 'public' | 'friends_only', required — The privacy of the account
  - `region` string, nullable, required — The region of the account
  - `resources` Resource[], nullable, required — The resources the account has (permissions)
    - `resource` 'go_to_leaderboard_entry' | 'max_leaderboard_entries' | 'account_refresh_rate' | 'inventory_refresh_rate' | 'social_links' | 'vanity' | 'account_queues' | 'short_link_domain' | 'max_find_owners' | 'max_badge_crafters' | 'search_result_limit' | 'max_compare_accounts' | 'max_saved_searches' | 'profile_theme_color' | 'name_effect', required
    - `value` string, required — The value of the resource, this can be a string, number, boolean or even a cron expression
  - `roles` Role[], nullable, required — The roles the account has
    - `extras` object, nullable, required — Extra data associated with the role
    - `rating` integer, required — The higher the more presedence it has
    - `role` 'user' | 'donator' | 'staff' | 'developer' | 'partner' | 'owner' | 'amethyst' | 'amber' | 'emerald' | 'sapphire' | 'ruby' | 'diamond' | 'contributor' | 'early_supporter' | 'beta' | 'translator' | 'top_100' | 'badge_scout' | 'nitro_booster' | 'astral' | 'nebula', required
  - `sessions` Session[], nullable, required — The sessions the account has
    - `createdAt` string, date-time, required — The time the session was created
    - `expiresAt` string, date-time, required — The time the session expires
    - `ip` string, required — The ip of the session
    - `lastSeen` string, date-time, required — The time the session was last seen
    - `sessionId` string, required — The session id
    - `userAgent` string, required — The user agent of the session
  - `state` string, nullable, required — The state of the account
  - `vanity` string, nullable, required — The vanity of the account
  - `vanityUpdates` V1AccountVanityUpdate[], nullable, required — The vanity updates the account has
    - `updatedAt` string, date-time, required — The time the vanity was updated
    - `vanity` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry
  - `visibilityUpdates` V1AccountVisibilityUpdate[], nullable, required — The profile-visibility and steamsets-hidden changes the account has, newest first
    - `kind` 'profile' | 'apps' | 'friends' | 'steamsets', required — Which visibility changed: profile, apps and friends are Steam's three privacy settings, steamsets is the site-level hidden toggle
    - `updatedAt` string, date-time, required — The time the visibility was changed
    - `visibility` HistoryValue, required
      - `new` string, nullable, required — The new value of the history entry
      - `old` string, nullable, required — The old value of the history entry

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/steamsets/apis/steamsets-api.md) · [All operations](https://skmtc.net/steamsets/apis/steamsets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steamsets/steamsets-api/versions/f7c45c9ec36a/schema)