Get Workspaces - FormBharo

Get Workspaces

curl --request GET \
  --url https://form-fill-agent-backend.artpark.ai/api/v1/workspaces

[
  {
    "agent_count": 123,
    "id": "<string>",
    "is_personal": true,
    "name": "<string>",
    "owner_email": "<string>",
    "role": "admin"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

/

api

/

v1

/

workspaces

Get Workspaces

curl --request GET \
  --url https://form-fill-agent-backend.artpark.ai/api/v1/workspaces

[
  {
    "agent_count": 123,
    "id": "<string>",
    "is_personal": true,
    "name": "<string>",
    "owner_email": "<string>",
    "role": "admin"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Query Parameters

limit

integer | null

Maximum workspaces to return. Sending this switches the response to the paged object shape.

Required range: x >= 1

cursor

integer | null

Where to resume from: the next_cursor of the previous page. Sending this switches the response to the paged object shape.

Required range: x >= 0

Response

Successful Response

WorkspaceListItem · object[]
WorkspaceListPage · object

One row of GET /workspaces (also the shape returned when creating one).

agent_count

integer

required

id

string

required

is_personal

boolean

required

name

string

required

owner_email

string

required

role

enum<string>

required

Available options:

admin,

limited