Skip to content

Get current API key identity

GET
/api/v1/me
curl --request GET \
--url https://api.dokanmazad.com/api/v1/me \
--header 'X-API-Key: <X-API-Key>'

Success

Media typeapplication/json
object
success
required
boolean
data
required
meta
object
page
integer
limit
integer
total
integer
totalPages
integer
data
required
object
user
required

Authenticated user summary — { id, email, role }

object
tenant

Tenant the user belongs to — { id, name } or null for platform-level users

object
apiKey

API key metadata when authenticated via X-API-Key — { prefix, expiresAt, rateLimitPerMin, rateLimitPerDay }. null when authenticated via JWT.

object
environment
required

Server environment — development | staging | production | unknown

string
Examples
Examplesuccess
{
"success": true,
"data": {
"user": {
"id": "cmoabcde000002ny22aabbcc0",
"email": "partner@acme.com",
"role": "marketer"
},
"tenant": {
"id": "cmoabcde000003ny33aabbcc0",
"name": "ACME Motors"
},
"apiKey": {
"prefix": "dmz_pk_abc",
"expiresAt": "2027-05-06T07:41:59Z",
"rateLimitPerMin": 60,
"rateLimitPerDay": 5000
},
"environment": "production"
}
}

Unauthorized — missing or invalid API key

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
"success": false
}

Forbidden — route not in this key’s allowedRoutes

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
"success": false
}

Rate limit exceeded

Media typeapplication/json
object
success
required
boolean
error
required
string
statusCode
required
integer
Example
{
"success": false
}
Retry-After
integer

Seconds to wait before retrying