/v0/accounts/:identifier

GET

const url = 'http://localhost:3000/v0/accounts/:identifier';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/v0/accounts/:identifier

Parameters

Path Parameters

identifier

required

Any of:

string
string

Account name

string

Example

@johndoe@example.com

Account id

string

Example

31644833000002

Account name or id

Responses

200

application/json

object

required

Account ID

string

email

Account email address (only when logged in to an account with viewing privileges)

string

name

required

Account name

string

>= 8 characters <= 512 characters

nickname

required

Account nickname

string

>= 1 characters <= 256 characters

bio

required

Biography

string

0 <= 1024 characters

avatar

required

Avatar URL

string format: uri

header

required

Header URL

string format: uri

followed_count

required

Followed count

number

following_count

required

Following count

number

note_count

required

Note count

number

role

Account role (only when logged in to an account with viewing privileges)

string

status

Account status (only when logged in to an account with viewing privileges)

string

frozen

Account frozen status (only when logged in to an account with viewing privileges)

string

silenced

Account silenced status (only when logged in to an account with viewing privileges)

string

created_at

Account created at (only when logged in to an account with viewing privileges)

string format: date-time

Example

{
  "id": "38477395",
  "email": "johndoe@example.com",
  "name": "@johndoe@example.com",
  "nickname": "JohnDoe<:typescript:299384730049>",
  "bio": "",
  "avatar": "https://example.com/avatar.png",
  "header": "https://example.com/header.png",
  "followed_count": 100,
  "following_count": 100,
  "note_count": 100,
  "role": "normal",
  "status": "active",
  "frozen": "normal",
  "silenced": "normal",
  "created_at": "2021-01-01T00:00:00Z"
}

404

Not Found

application/json

Account not found

object

error

required

Account not found.

string

Allowed values: ACCOUNT_NOT_FOUND

Example

{
  "error": "ACCOUNT_NOT_FOUND"
}

500

Internal Server Error

application/json

object

error

required

Internal server error.

string

Allowed values: INTERNAL_ERROR

Example

{
  "error": "INTERNAL_ERROR"
}