One shared credit pool

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

The worked case: your plan includes 500 Find Contact Info credits. A teammate turns on Find Contact Info for a CSV of 200 projects and 180 of them return email or phone. You then unlock 300 more projects over the API. Searching and viewing along the way cost nothing.

Check the balance before you assume it

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

{
  "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"
  }
}

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.

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