Workspaces

List workspaces

GET /api/v1/workspaces

Returns the workspaces the caller is a member of. Not paginated. Service accounts are not workspace members and always receive an empty list.

Service account scope: workspaces:manage

Example request

curl "https://acme.formcel.com/api/v1/workspaces" \
  -H "Authorization: Bearer $FORMCEL_API_KEY"

Responses

• 200 The caller's workspaces.
• 401 The API key is missing or invalid.

Response body WorkspaceList

data array of WorkspaceSummary required

total integer required

limit integer required

offset integer required

WorkspaceSummary

id string required

name string required

color string required

May be empty.

role string required

owner, admin, editor or viewer. New values may be added.

created_at string (date-time) required

updated_at string (date-time) required

List workspace members

GET /api/v1/workspaces/{id}/members

Returns every member of the workspace. Any member can call it. Not paginated.

Service account scope: workspaces:manage

path parameters

id string required

Workspace ID.

Example request

curl "https://acme.formcel.com/api/v1/workspaces/ID/members" \
  -H "Authorization: Bearer $FORMCEL_API_KEY"

Responses

• 200 The workspace's members.
• 401 The API key is missing or invalid.
• 403 The caller lacks access to the resource, or the service account lacks the required scope.

Response body WorkspaceMemberList

data array of WorkspaceMember required

total integer required

limit integer required

offset integer required

WorkspaceMember

user_id string required

name string required

email string required

avatar_url string required

role string required

owner, admin, editor or viewer. New values may be added.

created_at string (date-time) required