All API endpoints require authentication using a Workspace API key. You’ll need to include this key in the request headers for all API calls.

Workspace API Key

Find your API key in your workspace settings. This key is unique to your workspace and should be kept secure.

API Key Authentication

Include the API key in the request headers:

Authorization Header x-api-key: your_workspace_api_key

Validate API Key

Validates a workspace API key and returns workspace details.

POST https://api.formo.so/api/validate-api-key

Request Body

{
	"apiKey": "string"
}

Response

{
	"isSuccess": true,
	"data": {
		"validated": true,
		"details": "API key validated successfully for workspace: {workspace_name}",
		"teamId": "string"
	}
}

Error Responses

  • 401 - Missing or invalid API key
  • 500 - Server error