Get Your Workspace Details via the ChatbotX REST API

Use this endpoint to fetch the details of the workspace associated with your API token. The response includes your workspace’s configuration settings such as its name, default reply, target country, language, timezone, brand colour, development mode status, and logo URL. This is a useful first call to confirm your API credentials and retrieve your workspace ID for use in other requests.

GET /api/v1/workspaces

Code Examples

curl --request GET \
  --url https://app.chatbotx.io/api/v1/workspaces \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatbotx.io/api/v1/workspaces"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)
print(response.json())

const options = {
  method: 'GET',
  headers: { Authorization: 'Bearer <token>' }
};

fetch('https://app.chatbotx.io/api/v1/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with the workspace configuration object.

Response Fields

string

required

The unique numeric identifier for the workspace.

string

required

The display name of the workspace.

string | null

required

The default fallback reply message sent when no flow matches, or null if none is configured.

string | null

required

The ISO country code of the workspace’s primary target market, or null if not set.

string

required

The default language code for the workspace (e.g., en).

string

required

The IANA timezone string for the workspace (e.g., America/New_York).

string

required

The hex colour code used as the workspace’s brand colour (e.g., #4F46E5).

boolean

required

When true, the workspace is in development mode and live messages are suppressed.

string | null

required

A URL to the workspace’s logo image, or null if no logo has been uploaded.

string

The ID of the user who owns the workspace.

string

required

ISO 8601 timestamp for when the workspace was created.

string

required

ISO 8601 timestamp for when the workspace was last updated.

Example Response

{
  "id": "42",
  "name": "Acme Corp Support",
  "defaultReply": "Sorry, I didn't understand that. Can you try again?",
  "targetCountry": "US",
  "language": "en",
  "timezone": "America/New_York",
  "brandColor": "#4F46E5",
  "developmentMode": false,
  "logo": "https://cdn.chatbotx.io/logos/acme.png",
  "ownerId": "usr_owner_001",
  "createdAt": "2023-01-15T09:00:00Z",
  "updatedAt": "2024-03-10T14:22:00Z"
}

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

Get Your Workspace Details via the ChatbotX REST API

Code Examples

Response

Response Fields

Example Response

​Code Examples

​Response

​Response Fields

​Example Response

Code Examples

Response

Response Fields

Example Response