Retrieve your account
GET /v1/meReturns the account the key belongs to. Use it as your connection test. A
200 means the key is valid and active, and the response gives you a label to
show for the connection. The call costs no credits and does not count against
the verify rate limit.
curl https://api.tryverifyemail.com/v1/me \ -H "Authorization: Bearer sk_your_api_key"const res = await fetch("https://api.tryverifyemail.com/v1/me", { headers: { Authorization: `Bearer ${process.env.VERIFYEMAIL_API_KEY}` },});if (res.status === 401) throw new Error("Invalid or revoked API key");const account = await res.json();import os, requests
res = requests.get( "https://api.tryverifyemail.com/v1/me", headers={"Authorization": f"Bearer {os.environ['VERIFYEMAIL_API_KEY']}"},)res.raise_for_status()account = res.json()Response
Section titled “Response”{ "email": "jane@acme.com", "plan": "growth", "credits_available": 1240, "api_key": { "id": "3f2a9c1e-7b4d-4e8a-9f60-2c1d8e5b7a90", "label": "Zapier", "mode": "live" }}| Field | Description |
|---|---|
email |
The email address of the account that owns the key. |
plan |
The account’s plan: free, starter, growth or scale. |
credits_available |
Credits you can spend right now, plan credits and top-up credits combined. The dashboard shows the same number. |
api_key.id |
The id of the key that made the call. It matches the key’s row on the API Keys page. |
api_key.label |
The name you gave the key when you created it. |
api_key.mode |
live or test, the type you picked when you created the key. |
The dashboard calls this endpoint with your signed-in session instead of a key.
Those responses carry api_key: null.
Errors
Section titled “Errors”| Status | Body | When |
|---|---|---|
401 |
{ "error": "Unauthorized" } |
The key is missing, malformed, revoked, or not one we issued. |
See also
Section titled “See also”- Authentication covers creating, rotating and revoking keys
- Rate limits explains why only the verify call is limited
- Account & billing explains how credits work