PerfectParser Docs

Get Account

Reference for the GET /v1/me endpoint.

GET /v1/me

Returns the identity and plan information for the authenticated API key. Use this to confirm your key is valid before submitting extractions.

curl https://api.perfectparser.com/v1/me \
  -H "X-API-Key: pp_live_your_secret_key"

Response 200 OK

{
  "user": {
    "user_id": "usr_abc123",
    "email": "you@example.com",
    "name": "Jane Doe",
    "credits_available": 847,
    "key_name": "Production Zapier",
    "key_expires_at": null,
    "member_since": "2026-01-15T08:00:00.000Z"
  }
}

Response Properties

FieldTypeDescription
user.user_idstringUnique user identifier.
user.emailstringAccount email address.
user.namestringDisplay name, if set.
user.credits_availableintegerTotal non-expired credits remaining.
user.key_namestringHuman-readable label for this API key.
user.key_expires_atstring | nullKey expiry, or null if the key never expires.
user.member_sincestringAccount creation timestamp (ISO 8601).

Common Error Responses

HTTP StatusError CodeDescription
401UNAUTHORIZEDInvalid or missing API key.

On this page