Skip to content
Open Markdown

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)

FieldTypeRequiredDescription
idstring<uuid>yes-
usernamestring | nullyes-
display_namestring | nullyes-
first_namestring | nullyes-
last_namestring | nullyes-
biostring | nullyes-
avatar_urlstring | nullyes-
visibilitystringyesOne of: "public", "friends", "private"
statusstringyesOne of: "active", "banned", "deleted"
localestring | nullyes-
timezonestring | nullyes-
created_atstring<date-time>yes-
updated_atstring<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)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional 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();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

GET/v1/me

Your token stays in this tab's memory and is sent only when you press Send request.

Built for developers. Ready for agents.