InboxKit

Get workspace details

GET

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

Workspaces

Maintainer:Not configured

Retrieve detailed information for a specific workspace

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.inboxkit.com/v1/api/workspaces/details?uid'

Response Example

{
    "error": false,
    "message": "Workspace fetched successfully",
    "workspace": {
        "uid": "ws_123456789",
        "name": "Marketing Team",
        "webhook_url": "https://example.com/webhook",
        "use_shared_billing": true,
        "members": [
            {
                "email": "[email protected]",
                "role": "admin",
                "full_name": "John Doe",
                "uid": "string"
            }
        ],
        "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 ********************

Query Params

uid

string

required

Workspace unique identifier

Example:

1234-5678-9012-3456

Responses

🟢200OK

application/json

Workspace details retrieved successfully

Body

error

boolean

optional

Example:

false

message

string

optional

Example:

Workspace fetched successfully

workspace

object

optional

uid

string

optional

Workspace unique identifier

Example:

ws_123456789

name

string

optional

Workspace name

Example:

Marketing Team

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

members

array [object {4}]

optional

Workspace members

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

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2025-06-17 13:00:15

List workspaces

Create workspace