> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snipp.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User

> Fetch a user profile. Pass `@me` or your own ID for your full account, including keys and limits.

Fetch your own account (`@me`) or another user's profile.

## Behavior

* `@me` or your own ID returns your full account: every profile field plus `api_key`, `key_has_uploads_access`, `upload_count` and `limits`, plus `relay_key`, `theme` and `subscription`. `api_key` and `key_has_uploads_access` describe your oldest app, since Relay authenticates with the relay key; `api_key` is `null` when you have no apps.
* Any other ID returns that user's public profile.
* `plan` is `free`, `plus` or `ultra`.
* `avatar` is always a URL. Users without an avatar get `https://cdn.snipp.gg/avatar.png`. `banner` is `null` when none is set.
* `bug_hunter_tier` is `0` (none), `1` (Bug Hunter) or `2` (Elite Bug Hunter).
* `following` and `blocking` are from your point of view: whether you follow or block that user. Both are `false` on your own profile.
* `limits.usage` is your weekly upload quota in bytes. `limits.priority_minutes` is your 30-day [priority minutes](/concepts/plans#priority-minutes) budget in minutes. `resets_at` is `null` if no window has been assigned yet.
* `limits.max_file_size` is the largest single file you can upload, in bytes.
* `upload_count` counts the files stored in your personal gallery.
* `theme` is your accent theme, or `null`. It is only returned on your own profile. Change it with [Update Profile](/relay-reference/endpoint/users/update).
* `subscription` is only returned on your own profile. See the table below.
* To list a user's posts, call [`GET /users/{id}/posts`](/relay-reference/endpoint/users/posts).
* If the user is suspended, the response is `403` with type `suspended` and their `username`. This is checked before blocks.
* If the user has blocked you, the response is `403` with type `blocked`.
* Team keys are not accepted here and get `401`.

## Examples

Fetch your own account:

```bash theme={null}
curl "https://relay.snipp.gg/users/@me" \
  -H "relay-key: YOUR_RELAY_KEY"
```

Fetch another user:

```bash theme={null}
curl "https://relay.snipp.gg/users/987654321098765432" \
  -H "relay-key: YOUR_RELAY_KEY"
```

## Responses

Your own account:

```json theme={null}
{
  "user": {
    "id": "123456789012345678",
    "username": "playerone",
    "nickname": "Player One",
    "avatar": "https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png",
    "banner": "https://i.snipp.gg/banners/123456789012345678/1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f.png",
    "bio": "Building things at Snipp",
    "socials": {
      "github": "https://github.com/playerone"
    },
    "plan": "plus",
    "verified": false,
    "staff": false,
    "partner": false,
    "translator": false,
    "bug_hunter_tier": 0,
    "suspended": false,
    "created_at": "2026-01-04T09:30:00.000Z",
    "custom_embed": null,
    "follower_count": 128,
    "following_count": 47,
    "following": false,
    "blocking": false,
    "api_key": "aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL",
    "key_has_uploads_access": true,
    "relay_key": "Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX",
    "upload_count": 42,
    "limits": {
      "max_file_size": 21474836480,
      "usage": {
        "used": 1073741824,
        "limit": 21474836480,
        "used_percent": 5,
        "resets_at": "2026-10-04T16:20:00.000Z"
      },
      "priority_minutes": {
        "used": 12,
        "limit": 100,
        "used_percent": 12,
        "resets_at": "2026-10-19T16:20:00.000Z"
      }
    },
    "theme": "pastel_blue",
    "subscription": {
      "status": "active",
      "started_at": "2026-01-04T09:30:00.000Z",
      "expires_at": "2026-11-04T09:30:00.000Z",
      "cancel_at_period_end": false,
      "gifted": false
    }
  }
}
```

Another user:

```json theme={null}
{
  "user": {
    "id": "987654321098765432",
    "username": "playertwo",
    "nickname": "Player Two",
    "avatar": "https://cdn.snipp.gg/avatar.png",
    "banner": null,
    "bio": null,
    "socials": null,
    "plan": "free",
    "verified": false,
    "staff": false,
    "partner": false,
    "translator": false,
    "bug_hunter_tier": 1,
    "suspended": false,
    "created_at": "2026-02-18T14:00:00.000Z",
    "custom_embed": null,
    "follower_count": 12,
    "following_count": 30,
    "following": true,
    "blocking": false
  }
}
```

A suspended user:

```json theme={null}
{
  "error": {
    "type": "suspended",
    "message": "This user has been suspended.",
    "username": "playertwo"
  }
}
```

## Subscription

Returned only on your own profile. Your plan is the top-level `plan` field.

| Field | Type | Description |
| - | - | - |
| `status` | string or null | `active`, `trialing`, `past_due`, `canceled` or another billing state, or `gifted` for a redeemed gift or comp. `null` on Free. |
| `started_at` | string or null | When the paid subscription began. `null` on Free, and for gifted plans with no subscription behind them. |
| `expires_at` | string or null | When access ends. For a renewing subscription this is the next billing date. For a gifted plan it is when the gift ends. |
| `cancel_at_period_end` | boolean | `true` when the subscription is canceled but access continues until `expires_at`. |
| `gifted` | boolean | `true` when the plan comes from a gift code or a comp rather than a paid subscription. |

## Errors

| Status | Type | When |
| - | - | - |
| `400` | `invalid_request` | `id` is not `@me` or a numeric ID |
| `401` | `unauthorized` | Missing or invalid key, or a team key |
| `403` | `suspended` | The user is suspended |
| `403` | `blocked` | The user has blocked you |
| `404` | `not_found` | No user with that ID |


## OpenAPI

````yaml relay-reference/openapi.json GET /users/{id}
openapi: 3.0.0
info:
  title: Snipp.gg Relay API
  description: >-
    First-party Snipp API for the full user experience: uploads, posts,
    discover, likes, comments, notifications, blocks and profile management.
  version: 3.0.0
servers:
  - url: https://relay.snipp.gg
    description: Default. Load-balanced across regions. No upload cap.
  - url: https://eu-west-1.relay.snipp.gg
    description: EU West regional endpoint. Pins uploads and storage to EU West.
  - url: https://us-west-1.relay.snipp.gg
    description: US West regional endpoint. Pins uploads and storage to US West.
  - url: https://pulsar.snipp.gg
    description: Alternative host. Capped at 100 MB per upload.
security:
  - relayKeyAuth: []
paths:
  /users/{id}:
    get:
      summary: Get User
      description: >-
        Fetch a user profile. Pass `@me` or your own ID for your full account,
        including keys and limits.
      operationId: getUser
      parameters:
        - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Success
          headers:
            request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    oneOf:
                      - $ref: '#/components/schemas/SelfUser'
                      - $ref: '#/components/schemas/User'
                required:
                  - user
              examples:
                self:
                  summary: '@me'
                  value:
                    user:
                      id: '123456789012345678'
                      username: playerone
                      nickname: Player One
                      avatar: >-
                        https://i.snipp.gg/avatars/123456789012345678/7e1f0a2b3c4d5e6f708192a3b4c5d6e7.png
                      banner: >-
                        https://i.snipp.gg/banners/123456789012345678/1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f.png
                      bio: Building things at Snipp
                      socials:
                        github: https://github.com/playerone
                      plan: plus
                      verified: false
                      staff: false
                      partner: false
                      translator: false
                      bug_hunter_tier: 0
                      suspended: false
                      created_at: '2026-01-04T09:30:00.000Z'
                      custom_embed: null
                      follower_count: 128
                      following_count: 47
                      following: false
                      blocking: false
                      api_key: aB3xK9mP2qR7sT1vW4yZ6cD8fG0hJ5kL
                      key_has_uploads_access: true
                      relay_key: Zy7wV4uT1sR8qP5nM2kJ9hG6fD3bC0aX
                      upload_count: 42
                      limits:
                        max_file_size: 21474836480
                        usage:
                          used: 1073741824
                          limit: 21474836480
                          used_percent: 5
                          resets_at: '2026-10-04T16:20:00.000Z'
                        priority_minutes:
                          used: 12
                          limit: 100
                          used_percent: 12
                          resets_at: '2026-10-19T16:20:00.000Z'
                      theme: pastel_blue
                      subscription:
                        status: active
                        started_at: '2026-01-04T09:30:00.000Z'
                        expires_at: '2026-11-04T09:30:00.000Z'
                        cancel_at_period_end: false
                        gifted: false
                other:
                  summary: Another user
                  value:
                    user:
                      id: '987654321098765432'
                      username: playertwo
                      nickname: Player Two
                      avatar: https://cdn.snipp.gg/avatar.png
                      banner: null
                      bio: null
                      socials: null
                      plan: free
                      verified: false
                      staff: false
                      partner: false
                      translator: false
                      bug_hunter_tier: 1
                      suspended: false
                      created_at: '2026-02-18T14:00:00.000Z'
                      custom_embed: null
                      follower_count: 12
                      following_count: 30
                      following: true
                      blocking: false
        '400':
          $ref: '#/components/responses/E400'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          $ref: '#/components/responses/E404'
        '405':
          $ref: '#/components/responses/E405'
        '429':
          $ref: '#/components/responses/E429'
        '500':
          $ref: '#/components/responses/E500'
components:
  parameters:
    UserId:
      name: id
      in: path
      required: true
      description: User ID, or `@me` for your own account.
      schema:
        type: string
      example: '@me'
  headers:
    RequestId:
      description: Unique ID for the request. Include it when contacting support.
      schema:
        type: string
        format: uuid
  schemas:
    SelfUser:
      allOf:
        - $ref: '#/components/schemas/User'
        - type: object
          properties:
            api_key:
              type: string
              nullable: true
              description: Your oldest app's API key, or null when you have no apps.
            key_has_uploads_access:
              type: boolean
              description: >-
                Whether that app has gallery access. False when you have no
                apps.
            relay_key:
              type: string
              description: Your relay key.
            upload_count:
              type: integer
              description: Number of stored files in your personal gallery.
            limits:
              $ref: '#/components/schemas/Limits'
            theme:
              type: string
              description: Your accent theme, or `null` when unset.
              nullable: true
            subscription:
              $ref: '#/components/schemas/Subscription'
          required:
            - api_key
            - key_has_uploads_access
            - relay_key
            - upload_count
            - limits
            - theme
            - subscription
      description: Returned for `@me` or your own ID.
    User:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
          nullable: true
        nickname:
          type: string
          nullable: true
        avatar:
          type: string
          description: Avatar URL. Falls back to `https://cdn.snipp.gg/avatar.png`.
        banner:
          type: string
          description: Banner URL, or `null` when unset.
          nullable: true
        bio:
          type: string
          nullable: true
        socials:
          type: object
          additionalProperties:
            type: string
          description: >-
            Keyed by `roblox`, `github`, `spotify`, `youtube`, `tiktok`, `X`,
            `bluesky`, `discord`.
          nullable: true
        plan:
          $ref: '#/components/schemas/Plan'
        verified:
          type: boolean
        staff:
          type: boolean
        partner:
          type: boolean
        translator:
          type: boolean
        bug_hunter_tier:
          type: integer
          enum:
            - 0
            - 1
            - 2
          description: '`0` none, `1` Bug Hunter, `2` Elite Bug Hunter.'
        suspended:
          type: boolean
        created_at:
          type: string
          format: date-time
          nullable: true
        custom_embed:
          $ref: '#/components/schemas/CustomEmbed'
          nullable: true
        follower_count:
          type: integer
        following_count:
          type: integer
        following:
          type: boolean
          description: You follow this user. `false` on your own profile.
        blocking:
          type: boolean
          description: You block this user. `false` on your own profile.
      required:
        - id
        - username
        - nickname
        - avatar
        - banner
        - bio
        - socials
        - plan
        - verified
        - staff
        - partner
        - translator
        - bug_hunter_tier
        - suspended
        - created_at
        - custom_embed
        - follower_count
        - following_count
        - following
        - blocking
    Limits:
      type: object
      properties:
        max_file_size:
          type: integer
          description: Largest single file in bytes.
        usage:
          $ref: '#/components/schemas/LimitWindow'
        priority_minutes:
          $ref: '#/components/schemas/LimitWindow'
      required:
        - max_file_size
        - usage
        - priority_minutes
      description: >-
        `usage` is the weekly upload quota in bytes. `priority_minutes` is the
        30-day priority streaming budget in minutes.
    Subscription:
      type: object
      properties:
        status:
          type: string
          description: >-
            `active`, `trialing`, `past_due`, `canceled` and other billing
            states, or `gifted`. `null` on Free.
          nullable: true
        started_at:
          type: string
          description: ISO 8601 UTC timestamp, for example `2026-01-04T09:30:00.000Z`.
          nullable: true
        expires_at:
          type: string
          description: ISO 8601 UTC timestamp, for example `2026-11-04T09:30:00.000Z`.
          nullable: true
        cancel_at_period_end:
          type: boolean
        gifted:
          type: boolean
      required:
        - status
        - started_at
        - expires_at
        - cancel_at_period_end
        - gifted
    Plan:
      type: string
      enum:
        - free
        - plus
        - ultra
    CustomEmbed:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        theme_color:
          type: string
        small_text:
          type: string
      description: Custom embed settings. Keys are omitted when unset.
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      description: Every non-2xx response has this body.
    LimitWindow:
      type: object
      properties:
        used:
          type: integer
        limit:
          type: integer
        used_percent:
          type: integer
          description: Rounded to the nearest integer.
        resets_at:
          type: string
          format: date-time
          description: When the window resets. `null` before your first upload or stream.
          nullable: true
      required:
        - used
        - limit
        - used_percent
        - resets_at
    ErrorDetail:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ErrorType'
        message:
          type: string
          description: Human-readable sentence. Do not match on it; use `type`.
        username:
          type: string
          description: >-
            `suspended` on `GET /users/{id}` only: the suspended user's
            username.
        quota:
          type: integer
          description: >-
            `quota_exceeded` only: the limit, in bytes for the weekly quota or
            minutes for priority minutes.
        used:
          type: integer
          description: >-
            `quota_exceeded` only: usage in the current window, in the same unit
            as `quota`.
        resets_at:
          type: string
          format: date-time
          description: '`quota_exceeded` only: when the window resets.'
          nullable: true
        failed:
          type: array
          items:
            $ref: '#/components/schemas/FailedFile'
          description: '`upload_failed` only: one entry per file.'
      required:
        - type
        - message
    ErrorType:
      type: string
      enum:
        - invalid_request
        - unauthorized
        - forbidden
        - suspended
        - blocked
        - moderated
        - plan_required
        - not_found
        - method_not_allowed
        - file_too_large
        - unsupported_type
        - quota_exceeded
        - rate_limited
        - upload_failed
        - internal
        - unavailable
      description: Machine-readable error category. See [Errors](/concepts/errors).
    FailedFile:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based position of the file in the request.
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - index
        - error
      description: >-
        A file that was not stored. `error` has the same shape as a top-level
        error.
  responses:
    E400:
      description: Invalid request
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E401:
      description: Missing or invalid key
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E403:
      description: Not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E404:
      description: Not found
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E405:
      description: Method not allowed
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Allow:
          description: Methods this path accepts.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E429:
      description: Rate limited
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    E500:
      description: Internal error
      headers:
        request-id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    relayKeyAuth:
      type: apiKey
      in: header
      name: relay-key
      description: Your relay key from snipp.gg/settings/relay

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.