Skip to main content
GET
/
workspaces
/
{ws_id}
Get workspace details
curl --request GET \
  --url https://app.blinkops.com/api/v1/workspaces/{ws_id} \
  --header 'BLINK-API-KEY: <api-key>'
{
  "description": "<string>",
  "display_name": "<string>",
  "enable_overview_page": true,
  "entities": [
    {
      "email": "<string>",
      "id": "<string>",
      "is_invite": true,
      "member_count": 123,
      "members": [
        "<string>"
      ],
      "name": "<string>",
      "type": "<string>",
      "workspace_role": "<string>"
    }
  ],
  "id": "<string>",
  "name": "<string>",
  "type": "<string>"
}

Authorizations

Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.

Path Parameters

ws_id
string
required

The ID of the workspace to retrieve

Response

Workspace details

description
string
display_name
string
enable_overview_page
boolean
entities
object[]
id
string
name
string
type
string