Get User

curl --request GET \
  --url https://relay.snipp.gg/users/{id} \
  --header 'relay-key: <api-key>'

const options = {method: 'GET', headers: {'relay-key': '<api-key>'}};

fetch('https://relay.snipp.gg/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://relay.snipp.gg/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "relay-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://relay.snipp.gg/users/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("relay-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://relay.snipp.gg/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["relay-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  }
}

GET

users

{id}

Get User

curl --request GET \
  --url https://relay.snipp.gg/users/{id} \
  --header 'relay-key: <api-key>'

const options = {method: 'GET', headers: {'relay-key': '<api-key>'}};

fetch('https://relay.snipp.gg/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://relay.snipp.gg/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "relay-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://relay.snipp.gg/users/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("relay-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://relay.snipp.gg/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["relay-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  }
}

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 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.
subscription is only returned on your own profile. See the table below.
To list a user’s posts, call GET /users/{id}/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:

curl "https://relay.snipp.gg/users/@me" \
  -H "relay-key: YOUR_RELAY_KEY"

Fetch another user:

curl "https://relay.snipp.gg/users/987654321098765432" \
  -H "relay-key: YOUR_RELAY_KEY"

Responses

Your own account:

{
  "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:

{
  "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:

{
  "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

Authorizations

relay-key

string

header

required

Your relay key from snipp.gg/settings/relay

Path Parameters

string

required

User ID, or @me for your own account.

Response

Success

user

object

required

Returned for @me or your own ID.

Option 1
Option 2

Show child attributes

Overview

Uploads

Posts

Likes and Comments

Users

Social

Notifications

Account

Meta

Get User

Behavior

Examples

Responses

Subscription

Errors

Authorizations

Path Parameters

Response

​Behavior

​Examples

​Responses

​Subscription

​Errors

Authorizations

Path Parameters

Response

Behavior

Examples

Responses

Subscription

Errors