# Accessible Workspaces API V3 — Developer Guide

- **Applies to:** Sprinklr Accessible Workspaces API V3 (`/api/v3/accessibleClients`)
- **V2 API reference:** [Accessible Workspaces API | Sprinklr Developer Portal](https://dev.sprinklr.com/fetch-accessible-workspaces)


## 1. Overview

The **Accessible Workspaces API** returns the list of all workspaces (clients) that the authenticated user has access to, scoped to the partner ID for which the token was generated.

This endpoint replaces the V2 path `/api/v2/client/accessible-clients` with a simplified V3 resource:

| Operation | Method | Path |
|  --- | --- | --- |
| Fetch accessible workspaces | `GET` | `/api/v3/accessibleClients` |


## 2. Base URLs and environments

All API calls are sent to the production endpoint:

```
https://api3.sprinklr.com/{env}/api/v3
```

So the accessible workspaces resource in production is:

```
https://api3.sprinklr.com/{env}/api/v3/accessibleClients
```

Replace `{env}` with your assigned environment identifier (`prod0`, `prod2`, `prod11`, etc.).

QA and pre‑production environments use a different host shape, in which the environment is a **hostname prefix** rather than a path segment.

## 3. Authentication and common headers

All Accessible Workspaces API calls are authenticated with OAuth 2.0. See API Overview for portal registration, API key and secret generation, and the Authorize flow.

| Header | Value | Purpose | Required on |
|  --- | --- | --- | --- |
| `Authorization` | `Bearer {{accessToken}}` | Authenticates the user with the server | All requests |
| `Key` | `{{apiKey}}` | Authenticates the application with the server | All requests |
| `Content-Type` | `application/json` | Declares the request body media type | All requests |
| `Accept` | `application/json` | Declares the acceptable response type | All requests |


## 4. Read operation

### 4.1 Fetch accessible workspaces

**`GET /api/v3/accessibleClients`**

Returns the list of workspace IDs and names available to the authenticated user.

#### Request

```bash
curl --location --request GET 'https://api3.sprinklr.com/{env}/api/v3/accessibleClients' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Accept: application/json'
```

#### Response

```bash
{
    "data": [
        {
            "id": "66000002",
            "name": "QA-3"
        },
        {
            "id": "66000003",
            "name": "client 66000003"
        },
        {
            "id": "66000004",
            "name": "Research"
        },
        {
            "id": "66000010",
            "name": "self_serve_66000009"
        },
        {
            "id": "66000050",
            "name": "Akhil's workspace (DND)"
        }
    ],
    "errors": []
}
```

## 5. Response format and parameters

The V3 envelope is consistent across endpoints:

```json
{
  "data": [ ... ],
  "errors": []
}
```

| **Field** | **Type** | **Description** |
|  --- | --- | --- |
| data | Array | Array of workspace objects |
| data[].id | Integer | Workspace ID |
| data[].name | String | Workspace name |
| errors | Array | Array of error objects (empty if no errors) |


## 7. Migration from V2 to V3

The Accessible Workspaces API in **V3** continues to provide the same functionality and response behavior as in V2.
The only change is the **endpoint path**, updated for consistency with other V3 APIs.

| **Operation** | **V2 Endpoint** | **V3 Endpoint** | **Key Differences** |
|  --- | --- | --- | --- |
| Fetch accessible workspaces | `GET /api/v2/client/accessible-clients` | `GET /api/v3/accessibleClients` | Path updated from `/api/v2/client/accessible-clients` to `/api/v3/accessibleClients`. |