GET
/
workspaces
Get current workspace consumption and billing information.
curl --request GET \
  --url https://api.captaindata.com/v4/workspaces \
  --header 'X-API-Key: <api-key>'
{
  "name": "Example Workspace",
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "credits_left": 50,
  "credits_max": 100,
  "credits_used": 50,
  "plan_name": "Growth",
  "current_month_start": "2023-10-01T00:00:00Z",
  "current_month_end": "2023-10-31T23:59:59Z",
  "identities_included": 10,
  "identities_synced": 2,
  "identities_remaining": 8
}

Authorizations

​
X-API-Key
string
header
required

API key required for authentication. Add your API key in the X-API-Key header.

Response

200
application/json

Successfully retrieved the current workspace consumption.

The response is of type object.