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
200The authenticated user.401The API key is missing or invalid.
Response body AuthMe
idstring requiredemailstring requirednamestring 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_idstring 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
200The workspace that is now active.400The request body or parameters are invalid.401The API key is missing or invalid.403The caller lacks access to the resource, or the service account lacks the required scope.
Response body WorkspaceSummary
idstring requirednamestring requiredcolorstring required- May be empty.
rolestring required- owner, admin, editor or viewer. New values may be added.
created_atstring (date-time) requiredupdated_atstring (date-time) required