Skip to main content
GET
/
v3
/
workspace
Get Workspace
curl --request GET \
  --url https://api.captaindata.co/v3/workspace \
  --header 'Authorization: <api-key>' \
  --header 'x-project-id: <api-key>'
{
  "name": "Captain Data",
  "email": "[email protected]",
  "plan_name": "Growth",
  "current_month_start": "2023-09-01T16:08:56+00:00",
  "current_month_end": "2023-10-01T17:08:56+00:00",
  "tasks_left": 9966,
  "tasks_max": 10000,
  "tasks_used": 0
}

Authorizations

​
Authorization
string
header
required

The Authorization header must include 'x-api-key' followed by your API key (e.g., 'Authorization: x-api-key YOUR_API_KEY').

​
x-project-id
string
header
required

Workspace UID required to identify the workspace.

Response

200 - application/json

Successful response containing user details.

​
name
string
required

The name of the workspace or account.

Example:

"Captain Data"

​
email
string<email>
required

The email address associated with the workspace.

Example:

"[email protected]"

​
plan_name
string
required

The name of the current subscription plan.

Example:

"Growth"

​
current_month_start
string<date-time>
required

The start date and time of the current billing month.

Example:

"2023-09-01T16:08:56+00:00"

​
current_month_end
string<date-time>
required

The end date and time of the current billing month.

Example:

"2023-10-01T17:08:56+00:00"

​
tasks_left
integer

The number of tasks remaining for the current period.

Example:

9966

​
tasks_max
integer

The maximum number of tasks allowed for the current period.

Example:

10000

​
tasks_used
integer

The number of tasks already used for the current period.

Example:

0