> ## Documentation Index
> Fetch the complete documentation index at: https://docs.theomnibot.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Your Workspace Details via the ChatbotX REST API

> Retrieve the full configuration details for your ChatbotX workspace, including name, timezone, brand settings, and owner information.

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.

<Info>
  **GET** `/api/v1/workspaces`
</Info>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url https://app.chatbotx.io/api/v1/workspaces \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

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

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

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

  ```javascript JavaScript theme={null}
  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));
  ```
</CodeGroup>

## Response

Returns `200 OK` with the workspace configuration object.

### Response Fields

<ResponseField name="id" type="string" required>
  The unique numeric identifier for the workspace.
</ResponseField>

<ResponseField name="name" type="string" required>
  The display name of the workspace.
</ResponseField>

<ResponseField name="defaultReply" type="string | null" required>
  The default fallback reply message sent when no flow matches, or `null` if none is configured.
</ResponseField>

<ResponseField name="targetCountry" type="string | null" required>
  The ISO country code of the workspace's primary target market, or `null` if not set.
</ResponseField>

<ResponseField name="language" type="string" required>
  The default language code for the workspace (e.g., `en`).
</ResponseField>

<ResponseField name="timezone" type="string" required>
  The IANA timezone string for the workspace (e.g., `America/New_York`).
</ResponseField>

<ResponseField name="brandColor" type="string" required>
  The hex colour code used as the workspace's brand colour (e.g., `#4F46E5`).
</ResponseField>

<ResponseField name="developmentMode" type="boolean" required>
  When `true`, the workspace is in development mode and live messages are suppressed.
</ResponseField>

<ResponseField name="logo" type="string | null" required>
  A URL to the workspace's logo image, or `null` if no logo has been uploaded.
</ResponseField>

<ResponseField name="ownerId" type="string">
  The ID of the user who owns the workspace.
</ResponseField>

<ResponseField name="createdAt" type="string" required>
  ISO 8601 timestamp for when the workspace was created.
</ResponseField>

<ResponseField name="updatedAt" type="string" required>
  ISO 8601 timestamp for when the workspace was last updated.
</ResponseField>

### Example Response

```json theme={null}
{
  "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"
}
```