Private beta Request access

Authentication

Verify credentials and choose the active workspace.

Get the authenticated user

GET /api/v1/auth/me

Returns the user the API key belongs to. Use it to verify that a key is valid.

Service account scope: forms:read

Example request

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

Responses

  • 200 The authenticated user.
  • 401 The API key is missing or invalid.

Response body AuthMe

id string required
email string required
name string required

Switch the active workspace

PATCH /api/v1/auth/workspace

Sets the active workspace for the current session. Only session-authenticated clients keep the change; requests authenticated with an API key always act in the key owner's default workspace. Service accounts are rejected with 400 because they have no active workspace.

Service account scope: workspaces:manage

Request body

workspace_id string required

Example request

curl -X PATCH "https://acme.formcel.com/api/v1/auth/workspace" \
  -H "Authorization: Bearer $FORMCEL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"ws_4b1d"}'

Responses

  • 200 The workspace that is now active.
  • 400 The request body or parameters are invalid.
  • 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 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