Registration

POST/api/auth/app-code-verify

Check an email code

Pixelfed only No token

Body parameters

emailstringrequired

verify_codestringrequired

Returns

curl -X POST "https://pixelfed.social/api/auth/app-code-verify" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dansup@example.com",
    "verify_code": "048213"
  }'

const res = await fetch("https://pixelfed.social/api/auth/app-code-verify", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "dansup@example.com",
    verify_code: "048213",
  }),
});

const check = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/auth/app-code-verify",
    headers={"Accept": "application/json"},
    json={
        "email": "dansup@example.com",
        "verify_code": "048213",
    },
)

check = res.json()

use Illuminate\Support\Facades\Http;

$check = Http::acceptJson()->post('https://pixelfed.social/api/auth/app-code-verify', [
    'email' => 'dansup@example.com',
    'verify_code' => '048213',
])->json();

Response

{
  "status": "success"
}

{
  "message": "The selected email is invalid.",
  "errors": {
    "email": ["The selected email is invalid."]
  }
}

{
  "status": "error",
  "message": "Too many verification attempts. Please request a new code."
}

POST/api/auth/onboarding

Complete in-app sign up

Pixelfed only No token

Body parameters

emailstringrequired

verify_codestringrequired

usernamestringrequired

namestring

passwordstringrequired

client_idstring

client_secretstring

scopestring

Returns

curl -X POST "https://pixelfed.social/api/auth/onboarding" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dansup@example.com",
    "verify_code": "048213",
    "username": "dansup",
    "name": "dansup",
    "password": "harbour-fog-1987",
    "client_id": "1842",
    "client_secret": "q8V3zN1rKcT0fYd6LwP2sHbJ7mXeA9uR4oGiE5nC",
    "scope": "read write follow push"
  }'

const res = await fetch("https://pixelfed.social/api/auth/onboarding", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "dansup@example.com",
    verify_code: "048213",
    username: "dansup",
    name: "dansup",
    password: "harbour-fog-1987",
    client_id: "1842",
    client_secret: "q8V3zN1rKcT0fYd6LwP2sHbJ7mXeA9uR4oGiE5nC",
    scope: "read write follow push",
  }),
});

const session = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/auth/onboarding",
    headers={"Accept": "application/json"},
    json={
        "email": "dansup@example.com",
        "verify_code": "048213",
        "username": "dansup",
        "name": "dansup",
        "password": "harbour-fog-1987",
        "client_id": "1842",
        "client_secret": "q8V3zN1rKcT0fYd6LwP2sHbJ7mXeA9uR4oGiE5nC",
        "scope": "read write follow push",
    },
)

session = res.json()

use Illuminate\Support\Facades\Http;

$session = Http::acceptJson()->post('https://pixelfed.social/api/auth/onboarding', [
    'email' => 'dansup@example.com',
    'verify_code' => '048213',
    'username' => 'dansup',
    'name' => 'dansup',
    'password' => 'harbour-fog-1987',
    'client_id' => '1842',
    'client_secret' => 'q8V3zN1rKcT0fYd6LwP2sHbJ7mXeA9uR4oGiE5nC',
    'scope' => 'read write follow push',
])->json();

Response

{
  "status": "success",
  "domain": "pixelfed.social",
  "token_type": "Bearer",
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxODQyIn0.kM2p",
  "refresh_token": "def50200a1c4e9b7f0d3a6c2e8b5f1d4a7c0e3b6",
  "expires_in": 30758400,
  "scope": ["read", "write", "follow", "push"],
  "client_id": "1842",
  "user": {
    "pid": "2",
    "username": "dansup"
  },
  "account": {
    "id": "2",
    "username": "dansup",
    "acct": "dansup",
    "display_name": "dansup",
    "locked": false,
    "followers_count": 0,
    "following_count": 0,
    "statuses_count": 0,
    "url": "https://pixelfed.social/dansup",
    "avatar": "https://pixelfed.social/storage/avatars/default.jpg",
    "local": true,
    "created_at": "2026-10-17T08:02:19.000000Z"
  }
}

{
  "status": "error",
  "code": "invalid_client",
  "message": "Invalid client credentials."
}

{
  "message": "The username has already been taken.",
  "errors": {
    "username": ["The username has already been taken."]
  }
}

{
  "status": "error",
  "code": "locked",
  "message": "Too many verification attempts. Please request a new code."
}

GET/api/v1.1/auth/iarpfc

Check legacy app sign up

Pixelfed only No token

Returns

curl "https://pixelfed.social/api/v1.1/auth/iarpfc" \
  -H "Accept: application/json"

const res = await fetch("https://pixelfed.social/api/v1.1/auth/iarpfc", {
  headers: {
    Accept: "application/json",
  },
});

const preflight = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1.1/auth/iarpfc",
    headers={"Accept": "application/json"},
)

preflight = res.json()

use Illuminate\Support\Facades\Http;

$preflight = Http::acceptJson()->get('https://pixelfed.social/api/v1.1/auth/iarpfc')->json();

Response

{
  "open": true,
  "iara": true
}

POST/api/v1.1/auth/iar

Start legacy sign up

Pixelfed only No token

Body parameters

emailstringrequired

usernamestringrequired

passwordstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/auth/iar" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dansup@example.com",
    "username": "dansup",
    "password": "harbour-fog-1987"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/auth/iar", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "dansup@example.com",
    username: "dansup",
    password: "harbour-fog-1987",
  }),
});

const res = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/auth/iar",
    headers={"Accept": "application/json"},
    json={
        "email": "dansup@example.com",
        "username": "dansup",
        "password": "harbour-fog-1987",
    },
)

res = res.json()

use Illuminate\Support\Facades\Http;

$res = Http::acceptJson()->post('https://pixelfed.social/api/v1.1/auth/iar', [
    'email' => 'dansup@example.com',
    'username' => 'dansup',
    'password' => 'harbour-fog-1987',
])->json();

Response

{
  "success": true
}

{
  "error": "Too many requests"
}

{
  "error": ""
}

{
  "message": "The email has already been taken.",
  "errors": {
    "email": ["The email has already been taken."]
  }
}

GET/api/v1.1/auth/iarer

Legacy email redirect

Pixelfed only No token

Query parameters

utstringrequired

rtstringrequired

eastringrequired

Returns

curl "https://pixelfed.social/api/v1.1/auth/iarer?ut=7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz&rt=Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R&ea=bWFyYUBleGFtcGxlLmNvbQ==" \
  -H "Accept: application/json"

const res = await fetch("https://pixelfed.social/api/v1.1/auth/iarer?ut=7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz&rt=Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R&ea=bWFyYUBleGFtcGxlLmNvbQ==", {
  headers: {
    Accept: "application/json",
  },
});

const res = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1.1/auth/iarer",
    headers={"Accept": "application/json"},
    params={
        "ut": "7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz",
        "rt": "Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R",
        "ea": "bWFyYUBleGFtcGxlLmNvbQ==",
    },
)

res = res.json()

use Illuminate\Support\Facades\Http;

$res = Http::acceptJson()->get('https://pixelfed.social/api/v1.1/auth/iarer', [
    'ut' => '7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz',
    'rt' => 'Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R',
    'ea' => 'bWFyYUBleGFtcGxlLmNvbQ==',
])->json();

Response

null

{
  "message": "The rt field is required.",
  "errors": {
    "rt": ["The rt field is required."]
  }
}

POST/api/v1.1/auth/iarc

Confirm legacy sign up

Pixelfed only No token

Body parameters

user_tokenstringrequired

random_tokenstringrequired

emailstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/auth/iarc" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "user_token": "7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz",
    "random_token": "Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R",
    "email": "dansup@example.com"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/auth/iarc", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    user_token: "7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz",
    random_token: "Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R",
    email: "dansup@example.com",
  }),
});

const session = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/auth/iarc",
    headers={"Accept": "application/json"},
    json={
        "user_token": "7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz",
        "random_token": "Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R",
        "email": "dansup@example.com",
    },
)

session = res.json()

use Illuminate\Support\Facades\Http;

$session = Http::acceptJson()->post('https://pixelfed.social/api/v1.1/auth/iarc', [
    'user_token' => '7Hq2LmZ9xVb4NcR1sTe8KpW3yUa6JdF0gOiE5nXz',
    'random_token' => 'Rk4vT9pLq2Wm7Zc1Xs8Nb3Ye6Ja0Hd5Gf9Uo2Ii7Ee4Rt1Lq8Wm3Zc6Xs0Nb5Ye9Ja2Hd7Gf4Uo1Ii6Ee3R',
    'email' => 'dansup@example.com',
])->json();

Response

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIn0.Zq7d"
}

{
  "error": "Invalid tokens"
}

POST/api/v1.1/auth/invite/admin/verify

Check an invite

Pixelfed only No token

Body parameters

tokenstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/auth/invite/admin/verify" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "Xb7kQ2mZ9pLc"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/auth/invite/admin/verify", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    token: "Xb7kQ2mZ9pLc",
  }),
});

const invite = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/auth/invite/admin/verify",
    headers={"Accept": "application/json"},
    json={
        "token": "Xb7kQ2mZ9pLc",
    },
)

invite = res.json()

use Illuminate\Support\Facades\Http;

$invite = Http::acceptJson()->post('https://pixelfed.social/api/v1.1/auth/invite/admin/verify', [
    'token' => 'Xb7kQ2mZ9pLc',
])->json();

Response

{
  "message": "Welcome to the photo walk crew!",
  "max_uses": 25,
  "sev": true
}

{
  "error": "Invite has expired."
}

{
  "error": "Record not found"
}

POST/api/v1.1/auth/invite/admin/uc

Check a username for an invite

Pixelfed only No token

Body parameters

tokenstringrequired

usernamestringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/auth/invite/admin/uc" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "Xb7kQ2mZ9pLc",
    "username": "dansup"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/auth/invite/admin/uc", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    token: "Xb7kQ2mZ9pLc",
    username: "dansup",
  }),
});

const check = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/auth/invite/admin/uc",
    headers={"Accept": "application/json"},
    json={
        "token": "Xb7kQ2mZ9pLc",
        "username": "dansup",
    },
)

check = res.json()

use Illuminate\Support\Facades\Http;

$check = Http::acceptJson()->post('https://pixelfed.social/api/v1.1/auth/invite/admin/uc', [
    'token' => 'Xb7kQ2mZ9pLc',
    'username' => 'dansup',
])->json();

Response

[]

{
  "username": ["The username has already been taken."]
}

POST/api/v1.1/auth/invite/admin/ec

Check an email for an invite

Pixelfed only No token

Body parameters

tokenstringrequired

emailstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/auth/invite/admin/ec" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "Xb7kQ2mZ9pLc",
    "email": "dansup@example.com"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/auth/invite/admin/ec", {
  method: "POST",
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    token: "Xb7kQ2mZ9pLc",
    email: "dansup@example.com",
  }),
});

const check = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/auth/invite/admin/ec",
    headers={"Accept": "application/json"},
    json={
        "token": "Xb7kQ2mZ9pLc",
        "email": "dansup@example.com",
    },
)

check = res.json()

use Illuminate\Support\Facades\Http;

$check = Http::acceptJson()->post('https://pixelfed.social/api/v1.1/auth/invite/admin/ec', [
    'token' => 'Xb7kQ2mZ9pLc',
    'email' => 'dansup@example.com',
])->json();

Response

[]

{
  "email": ["The email has already been taken."]
}

{
  "error": "Too Many Attempts."
}

Pixelfed is free and open source software. Edit this page Report a docs issue