List workspaces

Returns a paginated list of workspaces you’ve previously created. The workspaces are returned in reverse chronological order: the most recently created workspace will appear first in the list.

Pass in a filter to only find the workspaces that have a matching name or public workspace key.

By default the call returns active and inactive workspaces. Add /active or /inactive to change that behaviour.

Text

GET https://api-{region}.seatsio.net/workspaces
GET https://api-{region}.seatsio.net/workspaces/active
GET https://api-{region}.seatsio.net/workspaces/inactive

GET https://api-{region}.seatsio.net/workspaces?filter=someWorkspace
GET https://api-{region}.seatsio.net/workspaces/active?filter=someWorkspace
GET https://api-{region}.seatsio.net/workspaces/inactive?filter=someWorkspace

More info: https://docs.seats.io/docs/api-pagination

PHP

// active and inactive workspaces
$client->workspaces->listFirstPage(pageSize?, filter?)
$client->workspaces->listPageAfter(afterId, pageSize?, filter?)
$client->workspaces->listPageBefore(beforeId, pageSize?, filter?)
$client->workspaces->listAll(filter?);

// active workspaces
$client->workspaces->active->firstPage(pageSize?, filter?)
$client->workspaces->active->pageAfter(afterId, pageSize?, filter?)
$client->workspaces->active->pageBefore(beforeId, pageSize?, filter?)
$client->workspaces->active->all(filter?)

// inactive workspaces
$client->workspaces->inactive->firstPage(pageSize?, filter?)
$client->workspaces->inactive->pageAfter(afterId, pageSize?, filter?)
$client->workspaces->inactive->pageBefore(beforeId, pageSize?, filter?)
$client->workspaces->inactive->all(filter?)

/*
Some examples (for charts, but listing workspaces works similarly):

https://github.com/seatsio/seatsio-php/blob/master/README.md#listing-charts-page-by-page
https://github.com/seatsio/seatsio-php/blob/master/README.md#listing-all-charts
*/

C#

// active and inactive workspaces
await client.Workspaces.ListFirstPageAsync(pageSize?, filter?)
await client.Workspaces.ListPageAfterAsync(afterId, pageSize?, filter?)
await client.Workspaces.ListPageBeforeAsync(beforeId, pageSize?, filter?)
client.Workspaces.ListAllAsync(filter?)

// active workspaces
await client.Workspaces.Active.FirstPageAsync(pageSize?, filter?)
await client.Workspaces.Active.PageAfterAsync(afterId, pageSize?, filter?)
await client.Workspaces.Active.PageBeforeAsync(beforeId, pageSize?, filter?)
client.Workspaces.Active.AllAsync(filter?)

// inactive workspaces
await client.Workspaces.Inactive.FirstPageAsync(pageSize?, filter?)
await client.Workspaces.Inactive.PageAfterAsync(afterId, pageSize?, filter?)
await client.Workspaces.Inactive.PageBeforeAsync(beforeId, pageSize?, filter?)
client.Workspaces.Inactive.AllAsync(filter?)

/*
Some examples (for charts, but listing workspaces works similarly):

https://github.com/seatsio/seatsio-dotnet/blob/master/README.md#listing-charts-page-by-page
https://github.com/seatsio/seatsio-dotnet/blob/master/README.md#listing-all-charts
*/

Java

// active and inactive workspaces
client.workspaces.listFirstPage(pageSize?, filter?)
client.workspaces.listPageAfter(afterId, pageSize?, filter?)
client.workspaces.listPageBefore(beforeId, pageSize?, filter?)
client.workspaces.listAll(filter?)

// active workspaces
client.workspaces.active.firstPage(pageSize?, filter?)
client.workspaces.active.pageAfter(afterId, pageSize?, filter?)
client.workspaces.active.pageBefore(beforeId, pageSize?, filter?)
client.workspaces.active.all(filter?)

// inactive workspaces
client.workspaces.inactive.firstPage(pageSize?, filter?)
client.workspaces.inactive.pageAfter(afterId, pageSize?, filter?)
client.workspaces.inactive.pageBefore(beforeId, pageSize?, filter?)
client.workspaces.inactive.all(filter?)

/*
Some examples (for charts, but listing workspaces works similarly):

https://github.com/seatsio/seatsio-java/blob/master/README.md#listing-charts-page-by-page
https://github.com/seatsio/seatsio-java/blob/master/README.md#listing-all-charts
*/

Python

# active and inactive workspaces
client.workspaces.list_first_page(page_size?, filter?)
client.workspaces.list_page_after(after_id, page_size?, filter?)
client.workspaces.list_page_before(before_id, page_size?, filter?)
client.workspaces.list(filter?)

# active workspaces
client.workspaces.active.first_page(page_size?, filter?)
client.workspaces.active.page_after(after_id, page_size?, filter?)
client.workspaces.active.page_before(before_id, page_size?, filter?)
client.workspaces.active.list(filter?)

# inactive workspaces
client.workspaces.inactive.first_page(page_size?, filter?)
client.workspaces.inactive.page_after(after_id, page_size?, filter?)
client.workspaces.inactive.page_before(before_id, page_size?, filter?)
client.workspaces.inactive.list(filter?)

"""
Some examples (for charts, but listing workspaces works similarly):

https://github.com/seatsio/seatsio-python/blob/master/README.md#listing-charts-page-by-page
https://github.com/seatsio/seatsio-python/blob/master/README.md#listing-all-charts
"""

Ruby

# active and inactive workspaces
client.workspaces.list(filter?).first_page(page_size?)
client.workspaces.list(filter?).page_after(after_id, page_size?)
client.workspaces.list(filter?).page_before(before_id, page_size?)
client.workspaces.list(filter?)

# active workspaces
client.workspaces.active(filter?).first_page(page_size?)
client.workspaces.active(filter?).page_after(after_id, page_size?)
client.workspaces.active(filter?).page_before(before_id, page_size?)
client.workspaces.active(filter?)

# inactive workspaces
client.workspaces.inactive(filter?).first_page(page_size?)
client.workspaces.inactive(filter?).page_after(after_id, page_size?)
client.workspaces.inactive(filter?).page_before(before_id, page_size?)
client.workspaces.inactive(filter?)

# Some examples (for charts, but listing workspaces works similarly):

# https://github.com/seatsio/seatsio-ruby/blob/master/README.md#listing-charts-page-by-page
# https://github.com/seatsio/seatsio-ruby/blob/master/README.md#listing-all-charts

Javascript

// active and inactive workspaces
client.workspaces.listFirstPage(filter?, pageSize?)
client.workspaces.listPageAfter(afterId, filter?, pageSize?)
client.workspaces.listPageBefore(beforeId, filter?, pageSize?)
client.workspaces.listAll(filter?)

// active workspaces
client.workspaces.active.firstPage(filter?, pageSize?)
client.workspaces.active.pageAfter(afterId, filter?, pageSize?)
client.workspaces.active.pageBefore(beforeId, filter?, pageSize?)
client.workspaces.active.all(filter?)

// inactive workspaces
client.workspaces.inactive.firstPage(filter?, pageSize?)
client.workspaces.inactive.pageAfter(afterId, filter?, pageSize?)
client.workspaces.inactive.pageBefore(beforeId, filter?, pageSize?)
client.workspaces.inactive.all(filter?)

/*
Some examples (for charts, but listing workspaces works similarly):

https://github.com/seatsio/seatsio-js/blob/master/README.md#listing-charts-page-by-page
https://github.com/seatsio/seatsio-js/blob/master/README.md#listing-all-charts
*/

Go

// active and inactive workspaces
page, err := client.Workspaces.ListFirstPage(workspaces.Active, <optional pagination params>)
page, err := client.Workspaces.ListPageAfter(afterId, workspaces.All, <optional pagination params>)
page, err := client.Workspaces.ListPageBefore(beforeId, workspaces.Inactive, <optional pagination params>)
Workspaces, err := client.Workspaces.ListAll(workspaces.Active, <optional pagination params>)

/*
Some examples (for charts, but listing workspaces works similarly):

https://github.com/seatsio/seatsio-go/blob/master/README.md#listing-charts-page-by-page
https://github.com/seatsio/seatsio-go/blob/master/README.md#listing-all-charts
*/

curl https://api-{region}.seatsio.net/workspaces?limit=100&start_after_id=34 \
-u anAdminKey:

The response will be a paginated JSON object that contains all workspaces for the authenticated company:

{
    "next_page_starts_after": 122,
    "items": [
        {
            "id": 169,
            "name": "a workspace",
            "key": "18725661-36d6-4755-905a-28ce82d0c2d5",
            "secretKey": "7c647eed-0880-4118-9459-82757579703e",
            "isDefault": true,
            "isTest": false,
            "isActive": true
        },
        {
            "id": 170,
            "name": "another workspace",
            "key": "34725661-36d6-4755-905a-28ce82d0c2d5",
            "secretKey": "56647eed-0880-4118-9459-82757579703e",
            "isDefault": false,
            "isTest": true,
            "isActive": false
        }
        ...
    ]
}