Get user profile

Retrieve the authenticated user’s profile information.

GET /v1/user/me

cURL

curl --request GET \
  --url https://api.paypulse.io/v1/user/me \
  --header 'Authorization: Bearer <token>'

200

{
  "message": "User profile retrieved successfully",
  "code": 200,
  "data": {
    "name": "Jane Doe",
    "email": "[e-mail]",
    "created_on": "2024-03-15",
    "gmail_account_connected": true
  }
}

Authentication

All requests to this endpoint must include a valid JWT in the Authorization header.

Authorization: Bearer <token>

Response

message · string

A human-readable confirmation message. Example: "User profile retrieved successfully"

code · number

HTTP status code. 200 on success.

data · object

Hide properties

name · string

The user’s display name.

email · string

The email address associated with the account.

created_on · string

The date the account was created, in YYYY-MM-DD format.

gmail_account_connected · boolean

Whether the user has linked a Gmail account. true if OAuth tokens are stored in Secrets Manager, false otherwise.

Error responses

Status	Error code	Description
401	INVALID_CREDENTIALS	The Authorization header is missing or the token is invalid.
401	TOKEN_EXPIRED	The JWT has expired.
404	USER_NOT_FOUND	No account exists for the user ID encoded in the token.
502	DEPENDENCY_FAILURE	A downstream dependency (DynamoDB or Secrets Manager) returned an error.
500	INTERNAL_SERVER_ERROR	An unexpected server-side error occurred.

Error responses follow this structure:

{
  "error": {
    "code": "USER_NOT_FOUND",
    "message": "User not found"
  }
}

cURL

curl --request GET \
  --url https://api.paypulse.io/v1/user/me \
  --header 'Authorization: Bearer <token>'

200

{
  "message": "User profile retrieved successfully",
  "code": 200,
  "data": {
    "name": "Jane Doe",
    "email": "[e-mail]",
    "created_on": "2024-03-15",
    "gmail_account_connected": true
  }
}