Appearance
Get the caller's profile
GET /v1/me
- Operation ID:
getMyProfile - Tags: Profile
- Base URL:
http://localhost:8787
Workflow: Integration guide.
Authentication: Platform user Bearer JWT. Acts only on the caller's own data.
Authentication
- Auth: Platform user Bearer JWT (
Authorization: Bearer <access_token>).
Responses
200
Profile.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (MyProfile)
| Field | Type | Required | Description |
|---|---|---|---|
id | string<uuid> | yes | - |
username | string | null | yes | - |
display_name | string | null | yes | - |
first_name | string | null | yes | - |
last_name | string | null | yes | - |
bio | string | null | yes | - |
avatar_url | string | null | yes | - |
visibility | string | yes | One of: "public", "friends", "private" |
status | string | yes | One of: "active", "banned", "deleted" |
locale | string | null | yes | - |
timezone | string | null | yes | - |
created_at | string<date-time> | yes | - |
updated_at | string<date-time> | yes | - |
Errors
401
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}404
profile_not_found.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "profile_not_found"
}500
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples
curl
bash
curl -X GET 'http://localhost:8787/v1/me' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/me", {
method: "GET",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();