Skip to main content

Get Me

Returns the UserIDInfo for the currently authenticated user based on the API key or JWT token in the request.

Endpoint

GET /v2/users/me

Response

Returns the UserIDInfo object for the caller's user account.

This endpoint is useful for confirming which user context an API key belongs to, verifying the effective AuthLevel, and troubleshooting authentication issues without needing to know a specific User ID.

{
"success": true,
"data": {
"userId": 1042,
"login": "jsmith",
"email": "jsmith@example.com",
"firstName": "John",
"lastName": "Smith",
"networkId": 1,
"mailboxId": 101,
"authLevel": "MailboxAdmin",
"status": "Active",
"created": "2024-03-15T10:22:00Z"
}
}

ENUMs

This endpoint returns the following ENUMs in its response. See Appendix: ENUMs for full value lists.

  • AuthLevel — the permission level of the authenticated user
  • Status — the lifecycle state of the authenticated user

Code Examples

curl -X GET "https://rest.ecgrid.io/v2/users/me" \
-H "X-API-Key: $ECGRID_API_KEY"

See Also