Skip to main content
POST
/
v1
/
me
Get authenticated user context
curl --request POST \
  --url https://{environment}.shortpen.com/v1/me \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status_code": 200,
  "data": {
    "name": "Ada",
    "surname": "Lovelace",
    "email": "ada@example.com",
    "enabledFeatures": {}
  },
  "message": ""
}
Returns the profile, organization context, and feature limits associated with the supplied API token.
The response mirrors the data that powers the ShortPen dashboard header. It is useful for confirming which workspace your automation will operate in and which plan limits are still available.

​
Response fields

  • data.name and data.surname — the contact name attached to the API key owner.
  • data.email — email address of the key owner.
  • data.enabledFeatures — a map keyed by feature slug. Each entry contains:
    • name: Human-readable label (for example URLs).
    • enabled: Whether the feature is active for the current plan.
    • limit, used, remaining: Numeric counters you can monitor to stay under plan quotas.
Use this endpoint before high-volume jobs to decide whether you need to queue or pause work when quotas are nearly exhausted.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Authenticated user context

​
success
boolean
required
Example:

true

​
status_code
integer
required
Example:

200

​
data
object
required
​
message
string
Example:

""