ChangelogOpen dashboard

Workspace

1 endpoint

The workspace, environment and abilities of the token you're using.

Get the current token#

GET/me
No token needed

Use this to check a token works and see what it can do — it's what Zapier's "Test connection" step should call. It needs no ability of its own, so it always answers once the token is valid, whatever platform_api_enabled says.

Responses

200
200 response
{
  "data": {
    "workspace": {
      "id": "0192f0a4-6b1e-7c3a-9d2f-5e8b1a4d1001",
      "name": "Acme Coffee"
    },
    "environment": "production",
    "abilities": [
      "reports:read",
      "campaigns:read",
      "campaigns:write"
    ],
    "platform_api_enabled": true
  }
}
Response fields
data
object
required
data.workspace
object
required
data.workspace.id
string
required
data.workspace.name
string
required
data.environment
string
required
data.abilities
string | string[]
required
data.platform_api_enabled
string
required

Whether abilities beyond reports:read currently work — the gate can close on an existing token, so this is worth surfacing alongside the abilities it was issued with.

401

The token is missing, expired or revoked.

unauthenticated
401 response
{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {}
  }
}
403

The token can't do this.

missing_abilityplatform_api_not_enabledwrong_environment
403 response
{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {}
  }
}
429

Too many requests. Wait for the number of seconds in Retry-After.

rate_limited
429 response
{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {}
  }
}
Request
curl 'https://api.bubbl.tech/platform/v1/me' \
  -H 'Accept: application/json'
Request
const response = await fetch('https://api.bubbl.tech/platform/v1/me', {
  method: 'GET',
  headers: {
    Accept: 'application/json',
  },
});

const data = await response.json();
Request
import requests

response = requests.request(
    'GET',
    'https://api.bubbl.tech/platform/v1/me',
    headers={
        'Accept': 'application/json',
    },
)
response.raise_for_status()
data = response.json()
Request
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bubbl.tech/platform/v1/me', [
    'headers' => [
        'Accept' => 'application/json',
    ],
]);

$data = json_decode((string) $response->getBody(), true);