GET /v1/me

Summary

Returns basic profile information about the user associated with the current API key. Use this endpoint to verify your credentials or retrieve account details.

HTTP Request

GET /v1/me

Response

Success (200 OK)

Returns a JSON object whose status is "SUCCESS" and a data object containing:

Field	Type	Description
username	string | null	The user's username, if set.
displayName	string | null	The user's display name, if set.
userFlags	integer	Bitwise flags representing account features.

Example response

{
  "status": "SUCCESS",
  "data": {
    "username": "janedoe",
    "displayName": "Jane Doe",
    "userFlags": 3
  }
}

Error responses

HTTP status	status code	Description
401	UNAUTHORIZED_ERROR	Missing or invalid API key.

See also

• Check credits: GET /v1/me/credits
• Authentication: Authentication