Skip to main content
GET
Get workspace credit balance
Authentication: workspace API key in Authorization: Bearer <key>.

Errors

Authorizations

Authorization
string
header
required

Create a workspace API key in the Deepline dashboard before calling authenticated endpoints.

Query Parameters

view
enum<string>

Set pill for the compact display response; omit for the full balance and exposure breakdown.

Available options:
pill

Response

Full balance, or a compact display response when view=pill.

org_id
string
required
balance
number
required
spendable_balance_credits
number | null
required
spendable_balance_status
enum<string>
required
Available options:
complete,
unavailable
exposure_status
enum<string>
required
Available options:
complete,
partial,
unavailable
balance_display
string
rough_usd_balance
number
posted_balance_credits
number | null
pending_spend_credits
number | null
spendable_balance_checked_at
string | null
spendable_balance_message
string
temporary_hold_credits
number | null
temporary_hold_credits_truncated
boolean | null
rough_usd_temporary_holds
number | null
estimated_hold_credits
number | null
incurred_unsettled_credits
number | null
pending_wallet_debit_credits
number | null
pending_wallet_refund_credits
number | null
unpriced_unsettled_reservation_count
number | null
exposure_message
string
temporary_hold_message
string
balance_status
string
has_payment_method
boolean
payment_method
object | null

Saved-card display metadata, or null. Never contains card credentials.

recovery
object

Present when funding needs attention. Recovery recommendations require explicit purchase approval.

updated_at
string | null