BluetickedDeveloper docs

Workspace

1 endpoint, each with examples that open in the console prefilled.

All resources
GET/api/v1/meworkspace:readTry in console

Get workspace context

Read the authenticated credential's organization, accessible businesses and effective permission boundary.

  • Call this first in an agent session. It is the authoritative boundary for business ids, environment and granted scopes.
  • A null allowed_business_ids means organization-wide access; a non-empty array is the complete business allowlist.
  • The environment is test for blu_test_ credentials and live for blu_live_ credentials.
curl -X GET "https://app.blueticked.com/api/v1/me" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"
Response
{
  "organization": {
    "id": "2706d599-3078-45f1-abbf-4c6ba1ed8d63",
    "name": "Karoo Trading Co",
    "timezone": "Africa/Johannesburg",
    "subscription_tier": "growth"
  },
  "businesses": [
    {
      "id": "22222222-2222-4222-9222-222222222222",
      "name": "Anzoset",
      "slug": "anzoset",
      "status": "active",
      "timezone": "Africa/Johannesburg",
      "is_default": false
    }
  ],
  "access": {
    "scopes": [
      "workspace:read",
      "contacts:read"
    ],
    "allowed_business_ids": [
      "22222222-2222-4222-9222-222222222222"
    ],
    "organization_wide": false,
    "environment": "test",
    "rate_limit_per_minute": 120
  },
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}