GET
Get workspace credits
Returns balances for the workspace tied to your Bearer token. Use this before calling credit-consuming People API search endpoints.

Authorizations

Authorization
string
header
required

Workspace JWT from Arxena auth.

Response

Workspace credit balances

orgChartCredits
number
required

Remaining org chart credits

Example:

12

revealCredits
number
required

Remaining reveal credit balance (raw units)

Example:

100

apiCredits
number
required

Remaining People API search credits

Example:

250

revealCreditsAsEmailEquivalent
number
required

How many email reveals the current reveal balance covers

Example:

10

revealCreditsAsPhoneEquivalent
number
required

How many phone reveals the current reveal balance covers

Example:

5

emailRevealCost
number
required

Reveal credits charged per email reveal

Example:

10

phoneRevealCost
number
required

Reveal credits charged per phone reveal

Example:

20