Get the workspace

The workspace this key acts in: plan, credits remaining, connected channels, and counts of active agents and contacts. A cheap first call that proves a key works and shows which workspace it landed in.

GEThttps://app.trygtm.com/api/v1/workspace
Scope
read

Request

curl https://app.trygtm.com/api/v1/workspace \
  -H "Authorization: Bearer $TRYGTM_API_KEY"

Response

{
  "data": {
    "workspace": "Northbeam",
    "organization": "Acme Agency",
    "plan": "agency",
    "credits_remaining": 18250,
    "active_agents": 5,
    "contacts": 2140,
    "channels": [
      {
        "kind": "email",
        "handle": "outreach@mail.acme.example",
        "status": "connected"
      }
    ],
    "your_access": {
      "role": "admin",
      "permissions": {}
    }
  }
}

Was this page helpful?