InboxKit

List workspaces

GET

https://api.inboxkit.com/v1/api/workspaces/list

Workspaces

Maintainer:Not configured

Get a list of all workspaces for the authenticated team

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.inboxkit.com/v1/api/workspaces/list'

Response Example

{
    "error": false,
    "message": "Workspaces fetched successfully",
    "workspaces": [
        {
            "uid": "ws_123456789",
            "name": "Marketing Team",
            "team": "string",
            "webhook_url": "https://example.com/webhook",
            "use_shared_billing": true,
            "domains": 5,
            "assigned_domains": 3,
            "assignable_domains": 2,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ]
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Workspaces retrieved successfully

Body

error

boolean

optional

Example:

false

message

string

optional

Example:

Workspaces fetched successfully

workspaces

array [object {10}]

optional

List of workspaces

uid

string

optional

Workspace unique identifier

Example:

ws_123456789

name

string

optional

Workspace name

Example:

Marketing Team

team

string

optional

Team reference ID

webhook_url

string | null

optional

Webhook URL for notifications

Example:

https://example.com/webhook

use_shared_billing

boolean

optional

Whether to use shared billing

Example:

true

domains

integer

optional

Total number of domains in workspace

Example:

assigned_domains

integer

optional

Number of domains with assigned mailboxes

Example:

assignable_domains

integer

optional

Number of domains available for assignment

Example:

created_at

string <date-time>

optional

Workspace creation timestamp

updated_at

string <date-time>

optional

Workspace last update timestamp

🟠401Unauthorized

🔴500Server Error

Modified at 2025-06-26 10:46:06

Get account details

Get workspace details