Fetch workspace

Fetch workspace

curl --request GET \
  --url https://app.getcensus.com/api/v1/workspaces/{workspace_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "My Workspace",
    "organization_id": 1,
    "created_at": "2023-09-05T19:42:42.672Z",
    "notification_emails": [
      "[email protected]"
    ]
  }
}

GET

workspaces

{workspace_id}

Fetch workspace

curl --request GET \
  --url https://app.getcensus.com/api/v1/workspaces/{workspace_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "My Workspace",
    "organization_id": 1,
    "created_at": "2023-09-05T19:42:42.672Z",
    "notification_emails": [
      "[email protected]"
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authorization using your Personal Access Token. Generate a new PAT on your user settings page.

Path Parameters

workspace_id

integer

required

ID of the workspace

Response

Successfully retrieved workspace details.

status

enum<string>

required

The outcome of the fetch request

Available options:

success

Example:

"success"

data

object

required

Show child attributes

data.id

integer

The id of the retrieved workspace.

Example:

123

data.name

string

The name of the workspace. Must be unique within the organization.

Example:

"My Workspace"

data.organization_id

integer

The id of the organization the workspace belongs to.

Example:

1

data.created_at

string<date-time>

The timestamp of when the workspace was created.

Example:

"2023-09-05T19:42:42.672Z"

data.notification_emails

string[]

The list of emails that will receive alerts from the workspace.

Example:

["[email protected]"]

Create workspace Fetch authenticated workspace

⌘I

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response