List accounts and usage

GET

api

partner

usage

Error

A valid request URL is required to generate request examples

{
  "month": "2026-06",
  "period": {
    "starts_at": "2026-06-01T00:00:00Z",
    "ends_at": "2026-07-01T00:00:00Z"
  },
  "accounts": [
    {
      "account_id": 412,
      "name": "Acme Legal",
      "external_id": "firm-8675309",
      "submissions_created": 84,
      "submissions_completed": 78,
      "templates_total": 12,
      "users_total": 3
    }
  ],
  "totals": {
    "submissions_created": 84,
    "submissions_completed": 78,
    "templates_total": 12,
    "users_total": 3
  }
}

{
  "error": "Unauthorized"
}

{
  "error": "Partner access is suspended"
}

{
  "error": "month cannot be in the future"
}

List managed accounts

curl "https://spitshake.io/api/partner/v1/accounts?page=1&per_page=25" \
  -H "Authorization: Bearer $SPITSHAKE_PARTNER_KEY"

Accounts are ordered by numeric ID. per_page defaults to 25 and is capped at 100.

200

{
  "data": [{
    "id": 412,
    "name": "Acme Legal",
    "external_id": "firm-8675309",
    "plan": "business",
    "admin_email": "admin@acme.example",
    "created_at": "2026-07-22T18:20:00Z",
    "usage_summary": {
      "users_active": 3,
      "templates_unarchived": 12,
      "submissions_this_month": 84
    }
  }],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

GET /api/partner/v1/accounts/{id} returns the same account object. An account owned by another partner returns 404, preventing ownership discovery.

Monthly usage

curl "https://spitshake.io/api/partner/v1/usage?month=2026-06" \
  -H "Authorization: Bearer $SPITSHAKE_PARTNER_KEY"

month uses YYYY-MM and defaults to the current month. Boundaries are UTC: starts_at is inclusive and ends_at is exclusive. Future or malformed months return 422.

200

{
  "month": "2026-06",
  "period": {
    "starts_at": "2026-06-01T00:00:00Z",
    "ends_at": "2026-07-01T00:00:00Z"
  },
  "accounts": [{
    "account_id": 412,
    "name": "Acme Legal",
    "external_id": "firm-8675309",
    "submissions_created": 84,
    "submissions_completed": 78,
    "templates_total": 12,
    "users_total": 3
  }],
  "totals": {
    "submissions_created": 84,
    "submissions_completed": 78,
    "templates_total": 12,
    "users_total": 3
  }
}

Created and completed submission counts use their respective timestamps. Template totals exclude archived templates and internal one-off templates, including cover-page clones. User totals include only active users.

422

{ "error": "month cannot be in the future" }

Authorizations

Authorization

string

header

required

Operator-issued partner key. Accepted only under /api/partner/v1.

Query Parameters

month

string

Defaults to the current UTC month. Future months are rejected.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$

Response

Per-account and aggregate usage

month

string

required

Pattern: ^\d{4}-(0[1-9]|1[0-2])$

period

object

required

Show child attributes

accounts

object[]

required

Show child attributes

totals

object

required

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "month": "2026-06",
  "period": {
    "starts_at": "2026-06-01T00:00:00Z",
    "ends_at": "2026-07-01T00:00:00Z"
  },
  "accounts": [
    {
      "account_id": 412,
      "name": "Acme Legal",
      "external_id": "firm-8675309",
      "submissions_created": 84,
      "submissions_completed": 78,
      "templates_total": 12,
      "users_total": 3
    }
  ],
  "totals": {
    "submissions_created": 84,
    "submissions_completed": 78,
    "templates_total": 12,
    "users_total": 3
  }
}

{
  "error": "Unauthorized"
}

{
  "error": "Partner access is suspended"
}

{
  "error": "month cannot be in the future"
}

Overview

Partner API

Templates

Thumbnails

Submissions

Submitters

Users

Access Tokens

Webhooks

Settings

Custom Domains

Teams

Audit Events

MFA

BAA

Security Events

Subscriptions

Plans

Payments

Verification

KBA

AI

Embed

Health

List accounts and usage

List managed accounts

Monthly usage

Authorizations

Query Parameters

Response

​List managed accounts

​Monthly usage

Authorizations

Query Parameters

Response

List managed accounts

Monthly usage