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

# Workspace Account

> Retrieve workspace information, balances, limits, plan details, and account configuration.

The Workspace Account endpoint provides information about your Zeckta workspace, including balances, messaging limits, billing configuration, plan information, and country restrictions.

This endpoint is useful for:

* Monitoring available SMS balances
* Checking workspace configuration
* Inspecting plan limits
* Reviewing country restrictions
* Understanding messaging quotas
* Building account dashboards

***

## Endpoint

```http theme={null}
GET /v1/workspaces/account
```

***

## Authentication

```http theme={null}
Authorization: Bearer YOUR_API_KEY
```

***

## Example Request

```bash theme={null}
curl -X GET https://api.zeckta.com/v1/workspaces/account \
  -H "Authorization: Bearer YOUR_API_KEY"
```

***

## Example Response

```json theme={null}
{
  "success": true,
  "message": "Workspace account retrieved successfully",
  "data": {
    "workspaceId": 1,
    "workspaceUuid": "7d8d73d4-21f5-4a89-8a76-72b0e48c6f12",
    "name": "Acme Corporation",
    "slug": "acme-corp",
    "ownerId": 1001,

    "balanceUnits": 50000,
    "bundleBalanceUnits": 25000,
    "totalAvailableUnits": 75000,

    "billType": "PREPAID",
    "currency": "GHS",

    "planName": "Business",
    "planMaxSenderNames": 25,

    "campaignMaxRecipients": 1000,

    "gsm7MaxSegments": 10,
    "ucs2MaxSegments": 8,

    "apiRateLimitPerSecond": 25,

    "workspaceStatus": "ACTIVE",

    "allowedCountries": [
      "GH",
      "NG",
      "KE"
    ],

    "blockedCountries": []
  }
}
```

***

## Response Fields

### Workspace Information

| Field           | Description                    |
| --------------- | ------------------------------ |
| `workspaceId`   | Internal workspace identifier. |
| `workspaceUuid` | Public workspace UUID.         |
| `name`          | Workspace name.                |
| `slug`          | Workspace slug.                |
| `ownerId`       | Internal owner identifier.     |

***

### Account Balances

| Field                 | Description                                |
| --------------------- | ------------------------------------------ |
| `balanceUnits`        | Available SMS units purchased directly.    |
| `bundleBalanceUnits`  | SMS units available from bundles.          |
| `totalAvailableUnits` | Total available units across all balances. |

***

### Billing

| Field      | Description                          |
| ---------- | ------------------------------------ |
| `billType` | Billing model used by the workspace. |
| `currency` | Account billing currency.            |

Examples:

```text theme={null}
PREPAID
POSTPAID
```

***

### Plan Limits

| Field                   | Description                              |
| ----------------------- | ---------------------------------------- |
| `planName`              | Current subscription plan.               |
| `planMaxSenderNames`    | Maximum number of sender names allowed.  |
| `campaignMaxRecipients` | Maximum recipients allowed per campaign. |

***

### Messaging Limits

| Field                   | Description                                         |
| ----------------------- | --------------------------------------------------- |
| `gsm7MaxSegments`       | Maximum GSM-7 message segments permitted.           |
| `ucs2MaxSegments`       | Maximum Unicode (UCS-2) message segments permitted. |
| `apiRateLimitPerSecond` | Maximum API requests allowed per second.            |

***

### Workspace Status

| Field             | Description                                  |
| ----------------- | -------------------------------------------- |
| `workspaceStatus` | Current operational status of the workspace. |

Common values:

```text theme={null}
ACTIVE
SUSPENDED
PENDING
DISABLED
```

***

### Country Restrictions

| Field              | Description                                    |
| ------------------ | ---------------------------------------------- |
| `allowedCountries` | Countries where message delivery is permitted. |
| `blockedCountries` | Countries blocked from message delivery.       |

Example:

```json theme={null}
{
  "allowedCountries": [
    "GH",
    "NG",
    "KE"
  ],
  "blockedCountries": [
    {
      "countryCode": "KP",
      "reason": "Restricted destination"
    }
  ]
}
```

***

## Common Use Cases

### Display Account Balance

Use this endpoint to display available SMS credits inside your application dashboard.

### Validate Campaign Limits

Check `campaignMaxRecipients` before creating large campaigns.

### Monitor API Limits

Use `apiRateLimitPerSecond` to tune client-side throttling.

### Enforce Country Policies

Review `allowedCountries` and `blockedCountries` before submitting messages.

***

## Related Resources

<CardGroup cols={2}>
  <Card title="SMS Messaging" href="/messaging/overview">
    Send transactional and bulk SMS messages.
  </Card>

  <Card title="Sender Names" href="/messaging/sender-names">
    Manage approved sender identities.
  </Card>
</CardGroup>