Account

Read the workspace operating picture

The workspace's operating picture in one call: credit balance, document count, envelope counts by outcome, and the five newest documents with the envelope each one produced.

This is the other half of the agent control plane. An agent polls it to answer the questions it would otherwise ask across four endpoints: can I afford to send, how much is outstanding, what did I upload last, and did any of it complete. It runs the same query the dashboard runs, so an agent and a human never disagree about how many envelopes are in flight.

The counts mean specific things:

  • documents.total: every document the workspace owns, whether or not it has an envelope.
  • documents.pending: envelopes in flight, which is pending plus completing.
  • documents.completed: envelopes that finished signing.
  • documents.sent: every envelope that ever left the workspace: in flight, completed, declined, voided, and expired. It is deliberately not pending + completed, because a voided envelope was still sent and was still charged for.

credits.balance and credits.policy mirror GET /credits/balance rather than restating them, so one field name carries the balance across the whole API. An unmetered workspace spends nothing per send and is never refused for credits.

Documents are named by public identifier only. No row ids and no storage keys appear here, and the workspace comes from the credential's binding, so nothing in the request can point this at another tenant.

get/account/summary

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/account/summary
  • Auth: HTTP bearer

Response

The workspace's balance, counts, and newest documents.

Example response

{
  "data": {
    "credits": {
      "balance": 42,
      "policy": "metered"
    },
    "documents": {
      "total": 128,
      "pending": 3,
      "sent": 97,
      "completed": 88
    },
    "recentDocuments": [
      {
        "id": "9pQmXbT4LrK2sVzD7hAeN",
        "filename": "master-services-agreement.pdf",
        "envelope": {
          "id": "b7Yc2NqTfW9pRz0KsXvLm",
          "status": "pending",
          "createdVia": "api"
        },
        "createdAt": "2026-08-19T14:22:07.481Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.