GET /profile

The GET /profile endpoint delivers a static profile payload so you can confirm account context or personalize downstream experiences. It does not require authentication, never consumes credits, and always returns a UserProfileResponse with basic identity attributes.

Request

• Method: GET
• Path: /profile
• Authentication: Not required
• Headers: Optional accept: application/json

GET https://api.brookmimir.com/profile
accept: application/json

Successful response

• HTTP status: 200 OK
• Body schema: UserProfileResponse
  • status (integer) — Numeric indicator of the call outcome.
  • message (string) — Human-readable description of the result.
  • user (UserInfo) — Object containing core profile attributes.

{
  "status": 200,
  "message": "User Profile",
  "user": {
    "name": "John Doe",
    "age": 30
  }
}

Field reference

Field	Type	Description
status	integer	HTTP-like status value indicating success or failure.
message	string	Text summary of the operation outcome.
user.name	string	Display name associated with the authenticated account.
user.age	integer	Age value supplied by the profile service (for demo purposes).

Error handling

• 400 Bad Request: Returned when headers are malformed or the request cannot be parsed (rare for this route).
• 5xx Server Errors: Signal temporary platform issues. Implement retry logic with exponential backoff.
• Network or TLS errors should be captured by your client instrumentation for observability.

Recommended usage