Docs
Dashboard Get an API key

Account

Get account

The account the key belongs to: its plan, the documents it can still send, and its verified custom domains.

GET/v1/me

Call it before sending to check documents.available, or to find the domain_host values you can send under.

Authorization

Authorizationstringheaderrequired
Bearer followed by your API key: Bearer sgk_…. The key also works in an X-Api-Key header. See Authentication.

Response

200 OKThe account object.
emailstring
The account's email address.
planstring
The membership.
One of free starter pro business
member_levelinteger
The membership as a number: 0 Free, 1 Starter, 2 Pro, 3 Business.
documentsobject
What you can still send. See Documents and plans.
ShowHide child attributes
availableinteger | null
Documents you can use now: this month's remaining allowance plus pack documents. null when unmetered.
unmeteredboolean
true for an account that is never charged documents.
monthlyobject | null
This month's allowance. null when unmetered.
ShowHide child attributes
grantedinteger
This month's allowance.
usedinteger
Used from it so far.
remaininginteger
Left in it.
period_startstring (date-time)
The start of the month (UTC).
resetsstring (date-time)
When the next allowance starts. Unused documents do not roll over.
packsinteger
Documents left in purchased packs. Packs never expire.
signers_per_documentinteger
Signers one document covers (3).
domainsarray of strings
Your verified custom domains, usable as domain_host when creating a pact.

Errors

StatusWhen
401 UnauthorizedThe API key is missing, wrong or revoked.
403 ForbiddenThe account's plan does not include API access (Pro and Business do).

Every error body is { "error": "message" }. See Errors.