Profiles · API reference

Profiles

actor-service

What every profile has, whatever its kind (profiles.md): who may see it and what may be posted on it, its admins, being turned off, archived, deleted and restored, being featured, and what its photos and videos start with about being downloaded. Each kind has these at its own address, /people/, /groups/, /events/ or /websites/, and they are listed under each kind as every profile's. Here as well: which profile an alias is, of any kind.

What profile an alias is

GET/actors/{alias}

Of any kind: what its own address begins with, and its id. The web app finds /@ana by it.

Who: Anyone, signed in or not

Parameters

aliasstringrequiredin path
A profile's alias: ana, anahita-atrium, or ana@mastodon.social for somebody elsewhere.

Answers

200
OK
actor.HandleResponse application/json
404
there is no such profile that the viewer may see

Request

curl "https://api.example.org/actors/<alias>"

const response = await fetch('https://api.example.org/actors/<alias>', {
  method: 'GET',
});
const answer = await response.json();

import requests

response = requests.get(
    "https://api.example.org/actors/<alias>",
)
answer = response.json()

Answer · 200

{
  "alias": "string",
  "id": 42,
  "kind": "string"
}

Written by Claude, reviewed by Rastin Mehr · About this