WorkspaceGET

Get current workspace

Returns the workspace associated with the X-Api-Key request header. Workspace IDs do not need to be sent in request bodies.

https://api.unifyport.ai/v1/workspace

Headers

X-Api-Key

stringrequired

Workspace API key. The workspace is resolved from this header.

Path parameters

This endpoint has no path parameters.

Request body

This endpoint does not require a JSON request body.

Response body

name

string

Workspace display name.

status

string

Workspace lifecycle state, such as active.

metadata

object

Your own environment labels stored on the workspace.

account_quota

number

Maximum number of provider accounts allowed in this workspace.

account_quota_unlimited

boolean

When true, the account quota is unlimited and account_quota is ignored.

Responses

200

200 OK

Request succeeded. See the example response body.

400

Bad Request

The request body, path, or parameters are invalid.

401

Unauthorized

The X-Api-Key header is missing or invalid.

409

Conflict

The requested operation conflicts with an existing provider account or resource.

500

Internal Server Error

The service encountered an unexpected error.

Request

curl -X GET https://api.unifyport.ai/v1/workspace \
  -H "X-Api-Key: <YOUR_API_KEY>"

Response

{
  "data": {
    "name": "Production Workspace",
    "status": "active",
    "metadata": {
      "env": "production"
    },
    "account_quota": 10,
    "account_quota_unlimited": false
  }
}