Skip to main content
GET
/
v1
/
workspaces
Get Workspaces
curl --request GET \
  --url https://api.getmaxim.ai/v1/workspaces \
  --header 'x-maxim-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "accountId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

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