Skip to main content
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

GET /v1/workspaces/account

​
Authentication

Authorization: Bearer YOUR_API_KEY

​
Example Request

curl -X GET https://api.zeckta.com/v1/workspaces/account \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "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

FieldDescription
workspaceIdInternal workspace identifier.
workspaceUuidPublic workspace UUID.
nameWorkspace name.
slugWorkspace slug.
ownerIdInternal owner identifier.

​
Account Balances

FieldDescription
balanceUnitsAvailable SMS units purchased directly.
bundleBalanceUnitsSMS units available from bundles.
totalAvailableUnitsTotal available units across all balances.

​
Billing

FieldDescription
billTypeBilling model used by the workspace.
currencyAccount billing currency.
Examples: 
PREPAID
POSTPAID

​
Plan Limits

FieldDescription
planNameCurrent subscription plan.
planMaxSenderNamesMaximum number of sender names allowed.
campaignMaxRecipientsMaximum recipients allowed per campaign.

​
Messaging Limits

FieldDescription
gsm7MaxSegmentsMaximum GSM-7 message segments permitted.
ucs2MaxSegmentsMaximum Unicode (UCS-2) message segments permitted.
apiRateLimitPerSecondMaximum API requests allowed per second.

​
Workspace Status

FieldDescription
workspaceStatusCurrent operational status of the workspace.
Common values: 
ACTIVE
SUSPENDED
PENDING
DISABLED

​
Country Restrictions

FieldDescription
allowedCountriesCountries where message delivery is permitted.
blockedCountriesCountries blocked from message delivery.
Example: 
{
  "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.

SMS Messaging

Send transactional and bulk SMS messages.

Sender Names

Manage approved sender identities.