List workspaces

Get details for all workspaces in the current organization.

Request schema

Query parameters

page

number

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

default:

per_page

number

Determines the number of results on each page. It can't exceed 100.

default:

maximum:

100

order

string

Organizes the results based on their creation time, either ascending or descending.

default:

desc

enum:

"asc""desc"

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/workspaces

GET /api/v1/workspaces?page=SOME_NUMBER_VALUE&per_page=SOME_NUMBER_VALUE&order=SOME_STRING_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved the list of workspaces.

`200`

status

stringrequired

The outcome of the request

enum:

"success"

pagination

objectrequired

An object to help you navigate the list of results.

total_records

number

Total records in the collection.

example:

per_page

number

Records on each page.

default:

example:

prev_page

number | null

The previous page number, or null for the first page.

example:

page

number

The current page number.

default:

example:

next_page

number | null

The next page number, or null if it's the last page.

example:

last_page

number

The number of the last page with records.

example:

data

arrayrequired

The list of results.

integer

The id of the retrieved workspace.

example:

123

name

string

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

example:

My Workspace

organization_id

integer

The id of the organization the workspace belongs to.

example:

created_at

string

The timestamp of when the workspace was created.

format:

date-time

example:

2023-09-05T19:42:42.672Z

notification_emails

array

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

example:

[ "notifications@mycompany.slack.com" ]

type:

string

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 123,
      "name": "My Workspace",
      "organization_id": 1,
      "created_at": "2023-09-05T19:42:42.672Z",
      "notification_emails": [
        "notifications@mycompany.slack.com"
      ]
    }
  ]
}