logo
WorkspacesGet workspace detail
Workspaces

Get workspace detail

Returns full workspace detail including members, settings, usage, and limits.

Workspace keys can only access their own workspace.

curl -X GET "https://api.sendkit.ai/v1/workspaces/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "id": "665a1b2c3d4e5f6a7b8c9d0e",
    "name": "My Sales Team",
    "ownerId": "664f0a1b2c3d4e5f6a7b8c9d",
    "members": [
      {
        "userId": "664f0a1b2c3d4e5f6a7b8c9d",
        "role": "owner",
        "joinedAt": "2025-06-01T10:30:00.000Z"
      },
      {
        "userId": "665b1c2d3e4f5a6b7c8d9e0f",
        "role": "admin",
        "joinedAt": "2025-06-05T09:00:00.000Z"
      },
      {
        "userId": "665c2d3e4f5a6b7c8d9e0f1a",
        "role": "member",
        "joinedAt": "2025-06-10T14:30:00.000Z"
      }
    ],
    "settings": {
      "allowMemberInvites": false,
      "defaultRole": "member"
    },
    "usage": {
      "totalCampaigns": 5,
      "totalLeads": 2500,
      "totalMailboxes": 8,
      "totalEmailsSent": 12000
    },
    "limits": {
      "maxMembers": 5,
      "maxCampaigns": 10,
      "maxLeads": 1000,
      "maxMailboxes": 3
    },
    "createdAt": "2025-06-01T10:30:00.000Z"
  }
}
GET
/v1/workspaces/{id}
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Path Parameters

idstring
Required

Resource ID

Responses

successboolean
dataobject