Skip to content
Signkoi
Developer docs

Account API

Who the API key belongs to, its scopes, plan and usage.

Retrieve the account

GET/v1/me

Returns the account the API key belongs to and the key itself (name, scopes, expiry). Works with any key; plan and usage are included only when the key has the account:read scope. A good first call to check your key.

Any API key — no scope needed.

Response

200The account.
Response objectAccount
  • objectstringrequired= "account"
  • idstringrequired
  • namestringrequired
  • emailstring · emailrequired
  • localestring | null

    Account language.

  • timezonestring | null

    IANA time zone.

  • api_keyobjectrequired

    The key that made this request.

    Child attributes
    • idstring
    • namestring
    • scopesarray of string
    • expires_atstring · date-time | null

      When the key stops working; null = never.

  • planstring

    Only with the account:read scope. free, pro, business, …

  • usageobject

    Only with the account:read scope.

    Child attributes
    • documents_this_periodinteger

      Documents created this billing month (website and API).

    • document_limitinteger | null

      Monthly allowance; null = unlimited.

Response headers: X-Request-Id, Signkoi-Version, X-RateLimit-Limit, X-RateLimit-Remaining.

Errors

  • 401Missing, invalid, expired or revoked API key (api_key_missing, invalid_api_key).
  • 403The key lacks a required scope (insufficient_scope) or the account is suspended (account_suspended).
  • 429Too many requests (rate_limited): your key's per-minute limit, or an endpoint's own limit. Wait for Retry-After seconds.
  • 500Something went wrong on our side (internal_error). Safe to retry with the same Idempotency-Key.

Every error uses the error object.

Example request

curl https://signkoi.com/api/v1/me \
  -H "Authorization: Bearer $SIGNKOI_API_KEY"

Example response

200 · application/json
{
  "object": "account",
  "id": "1842",
  "name": "Rina Koh",
  "email": "rina@acme.example",
  "locale": "en",
  "timezone": "Europe/London",
  "api_key": {
    "id": "311",
    "name": "CRM integration",
    "scopes": [
      "envelopes:read",
      "envelopes:write",
      "account:read"
    ],
    "expires_at": null
  },
  "plan": "pro",
  "usage": {
    "documents_this_period": 37,
    "document_limit": 200
  }
}