Skip to main content
GET
Get Workspaces

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Query Parameters

id
string

Optional workspace id to fetch a single workspace

name
string

Optional workspace name to filter by (exact match)

cursor
string

Cursor for pagination - id of the last item from the previous page

limit
integer
default:20

Maximum number of workspaces to return (1-100, default 20)

Required range: 1 <= x <= 100

Response

Workspaces retrieved successfully

data
object[]
required
pagination
object
required