Skip to main content
Docs / Two shared pools

Recipes

Two shared pools

Export records and Find Contact Info credits are each one team pool. The API, MCP, CSV, and the app draw on the same export counter.

Who this is for

Anyone on a team plan who is about to be surprised by a balance. If two people use Boardwalk and one of them uses the API, this page is the one that prevents the surprise.

The rule

A state plan starts the month with 200 Find Contact Info credits and 100,000 export records. A search returns 40 projects; 12 were already delivered and have not changed, so the page uses 28 export records and 0 contact credits. A teammate then asks for contacts on 10 of those projects and 7 return an email or phone: 7 contact credits, and the export counter stays at 28. Downloading the same 40 again, with nothing changed, still returns the file and adds 0 to either counter.

ActionExport records usedContact credits left
Month starts, one state0 of 100,000200
Search: 40 projects, 12 unchanged28200
Same file again, nothing changed28200
Contacts on 10 projects, 7 found28193
Contacts on 10 more, none found28193

Check the balance before you assume it

Read the shared balance

bash
curl 'https://api.boardwalkai.com/api/v1/account/credits' \
  -H 'Authorization: Bearer bwk_live_YOUR_KEY'

Response · HTTP 200

json
{
  "data": {
    "plan": "single_state",
    "planDisplayName": "State",
    "creditsLimit": 500,
    "creditsUsed": 200,
    "creditsRemaining": 300,
    "periodStart": "2026-08-01",
    "periodEnd": "2026-08-31",
    "resetsAt": "2026-09-01T00:00:00+00:00",
    "rateLimit": 60,
    "rateLimitPer": "minute",
    "isTeamPool": true,
    "poolUserId": 8814
  },
  "meta": {
    "requestId": "req_01K1QF3M0000EXAMPLE0001"
  }
}

The response shape on this page is the one the endpoint builds: the keys, their nesting, and their types are asserted against the shipping code by a test. The numbers inside it are the scenario being walked through, not a measurement of the corpus.

isTeamPool: true is the field that matters here. It says the numbers you are reading are the team's, not yours, and that a colleague can move them while you are not looking. poolUserId identifies the pool so two seats can tell they are drawing on the same one.

Credit costFree (0 credits)Free. Your plan, your Find Contact Info allowance, and exportCredits (limit, used, remaining, resetsAt) for the shared 100,000 export records a month.

What this means in practice

  • Do not build a client that assumes its own balance is the whole story. Read X-Credits-Remaining off each response, or re-read the balance, rather than decrementing a local counter.
  • Before a large pull, price it with the free count endpoint. It reads the same pool and reports the same remaining figure.
  • A 402 is not a failure of your credentials. Your key is fine; the pool is empty.

Next

Ready to make a call?

A free Boardwalk trial includes API access, 50 record-export credits (search, CSV, MCP), and 5 Find Contact Info lookups. Counting, taxonomy, location lookups, and the analytics plane cost nothing, so you can evaluate the data before you spend a credit.