CallFluent API: Workspace Management

The Workspace API allows you to create, manage, and organize workspaces in CallFluent. Each workspace can contain multiple AI agents, members, and configurations.

Base URL

All requests must be sent to:
https://api.callfluent.ai/api

---

Workspace Endpoints

1. Create a New Workspace

POST /workspace/create

Creates a new workspace with the given name.

Header

Include your API key in the Authorization header:

Authorization: Bearer {api_key}  

Request Body

Field	Type	Required	Description	Example
name	string	true	Name of the new workspace	"First Workspace"

Example Body

{

   “name”: “First Workspace”

}

Example Request

curl -X POST https://api.callfluent.ai/api/workspace/create \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{"name": "First Workspace"}'

Response

Example Success – 200

status code: 200: workspace list

{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace}

Errors

• 500 (Server Error) – Server error.

server error: status code: 500

{status: false, error: error_message}

• 400 (Bad Request) – Workspace limit error.

workspace limit error: status code: 400

{ 
        status: false,
        error: "Workspace creation limit exceeded.",
        message: "Please delete some before creating new ones.",
}

---

2. Get All Workspaces

GET /workspace/get-all

Retrieves all workspaces.

Header

Authorization: Bearer {api_key}  

Parameter

None

Example Request

curl -X GET https://api.callfluent.ai/api/workspace/get-all \
  -H "Authorization: Bearer {api_key}"

Response

Example Success

status code: 200: workspace list

{workspaces: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }

Errors

• 500 (Server Error) – Server error.

server error: status code: 500

{status: false, error: error_message}

---

3. Get Workspace Details

GET /workspace/get/{id}

Retrieves details of a specific workspace.

Path Parameters

Field	Type	Required	Description	Example
id	number	true	Workspace ID	1

Example Request

curl -X GET https://api.callfluent.ai/api/workspace/get/1 \
  -H "Authorization: Bearer {api_key}"

Response

Example Success

status code: 200: workspace detail

{status: true, data: workspaceInfo }

Errors

• 500 (Server Error) – Server error.

server error: status code: 500

{status: false, error: error_message}

---

4. Get Workspace Voice List

GET /workspace/{id}/voices

Retrieves the available voice list for a workspace.

Header

Authorization: Bearer {api_key}  

Path Parameters

Field	Type	Required	Description	Example
id	number	true	Workspace ID	14

Example Request

curl -X GET https://api.callfluent.ai/api/workspace/14/voices \
  -H "Authorization: Bearer {api_key}"

Response

Example Success

status code: 200: workspace voice list

[
  {
    "value": "alloy",
    "label": "Friendly and expressive male",
    "brand": "openai"
  },
  {
    "value": "echo",
    "label": "Clear and natural male",
    "brand": "openai"
  }
]

Errors

• 500 (Server Error) – Server error.

server error: status code: 500

{status: false, error: error_message}

---

5. Update Workspace

PUT /workspace/update/{id}

Updates a workspace.

Header

Authorization: Bearer {api_key}  

Path Parameters

Field	Type	Required	Description	Example
id	number	true	Workspace ID	14

Request Body

Field	Type	Required	Description	Example
name	string	false	Workspace name	"New Workspace"
sid	string	false	Twilio SID	ACXXXXXXXX
auth_token	string	false	Twilio auth token	b3a1dXXXX
elevenlabs_key	string	false	ElevenLabs API key	sk_XXX
openai_key	string	false	OpenAI API key	sk-proj-XXX
maxMins	number	false	Workspace monthly limit minutes	300
maxMembers	number	false	Max member count	10
maxAgents	number	false	Max agent count	6

Example Request

curl -X PUT https://api.callfluent.ai/api/workspace/update/14 \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "name": "New Workspace", "maxMins": 9999 }'

Response

Example Success

status code: 200: workspace list

{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }

Errors

• 500 (Server error) – Server error.

server error: status code: 500

{status: false, error: error_message}

• 403 (Permission Error) – Permission error.

permission error: status code: 403

{ 
        status: false,
        msg: "Your account doesn't have the permission to access that page."
}

---

6. Invite User to Workspace

POST /workspace/invite-user

Create a new guest and send an invite email.

Header

Authorization: Bearer {api_key}  

Request Body

Field	Type	Required	Description	Example
workspace_id	number	true	Workspace ID	14
email	string	true	Email of the new member	[email protected]

Example Request

curl -X POST https://api.callfluent.ai/api/workspace/invite-user \
  -H "Authorization: Bearer {api_key}" \
  -H "Content-Type: application/json" \
  -d '{ "workspace_id": 14, "email": "[email protected]" }'

Response

Example Success

status code: 200: workspace list

{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }

Errors

• 500 (Server Error) – Server error.

server error: status code: 500

{status: false, error: error_message}

• 403 (Permission error) – Permission error.

permission error: status code: 403

{ 
        status: false,
        msg: "Your account doesn't have the permission to access that page."
}

---

7. Delete Workspace Member

DELETE /workspace/invite-delete/{id}

Deletes a member from the workspace.

Header

Authorization: Bearer {api_key}  

Path Parameters

Field	Type	Required	Description	Example
id	number	true	Workspace user ID	11

Example Request

curl -X DELETE https://api.callfluent.ai/api/workspace/invite-delete/11 \
  -H "Authorization: Bearer {api_key}"

Response (Success – 200)

Example Success

status code: 200: workspace list

{status: true, data: [ {id: 1, name: “first workspace}, {id: 2, name: “second workspace} ] }

Errors

• 500 (Server Error) – Server error.

server error: status code: 500

{status: false, error: error_message}

• 403 (Permission error) – Permission error.

permission error: status code: 403

{ 
        status: false,
        msg: "Your account doesn't have the permission to access that page."
}

---

8. Delete a Workspace

DELETE /workspace/delete/{id}

Deletes a workspace.

Header

Authorization: Bearer {api_key}  

Path Parameters

Field	Type	Required	Description	Example
id	number	true	Workspace ID	1

Example Request

curl -X DELETE https://api.callfluent.ai/api/workspace/delete/1 \
  -H "Authorization: Bearer {api_key}"

Response

Example Success

status code: 200: workspace list

{status: true, data: [ {id: 2, name: “second workspace} ] }

Errors

• 500 (Server Error) – Server error.

server error: status code: 500

{ status: false, error: error_message}

• 403 (Permission Error) – Permission error.

permission error: status code: 403

{ 
        status: false,
        msg: "Your account doesn't have the permission to access that page."
}

---

9. Get GHL Calendar List

GET /workspace/calendars/{id}

Retrieves the list of GHL calendars linked to the workspace.

Header

Authorization: Bearer {api_key}  

Path Parameters

Field	Type	Required	Description	Example
id	number	true	Workspace ID	1

Response

Example Success

status code: 200: workspace list

{status: true, data: GHL_CALENDAR_LIST}

Errors

• 500 (Server Error) – Server error.

{status: false, error: error_message}

• 403 (Permission Error) – Permission error.

  { 
        status: false,
        msg: "Your account doesn't have the permission to access that page."
}

---

Conclusion

This covers all Workspace API endpoints for managing workspaces in CallFluent. For agent management, see the Agent Services Documentation.