Get the workspace

GET

/workspace

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

application/json

Success

idstringrequired

Workspace id. Send it in the bavlio-workspace header to act in this workspace.

org_idstringrequired

Tenant id (a UUID) that scopes the workspace's lead data.

namestringrequired

Company name.

sellsstringrequired

What the company sells, in one line.

problemsstring[]required

Problems the company solves for its customers.

customersstring[]required

Names of current customers; leads at these companies are skipped.

domainstring | nullrequired

Company website domain; null when there is none.

booking_linkstring | nullrequired

HTTPS link where leads book a meeting; null when none is set.

attributionenum<string> | nullrequired

Where the user heard about Bavlio; null when not recorded.

Available options: chatgpt, claude, perplexity, google, reddit, linkedin, youtube, friend, accelerator, other

timezonestringrequired

IANA time zone of the outreach schedule; UTC until one is set.

week_startenum<string>required

First day of the week in Bavlio's calendars.

Available options: monday, sunday

working_daysenum<string>[]required

Days of the week outreach runs on.

Available options: sunday, monday, tuesday, wednesday, thursday, friday, saturday

working_hoursobjectrequired

Hours of each working day during which outreach runs.

onboarded_atstring | nullrequired

When onboarding was completed, as an ISO 8601 timestamp; null until then.

created_atstringrequired

When the workspace was created, as an ISO 8601 timestamp.

Get the workspace

curl --request GET \
  --url https://api.bavlio.com/workspace \
  --header 'Authorization: Bearer <token>'

curl --request GET \  --url https://api.bavlio.com/workspace \  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "org_id": "<string>",
  "name": "<string>",
  "sells": "<string>",
  "problems": [
    "<string>"
  ],
  "customers": [
    "<string>"
  ],
  "domain": "<string>",
  "booking_link": "<string>",
  "attribution": "chatgpt",
  "timezone": "<string>",
  "week_start": "monday",
  "working_days": [
    "sunday"
  ],
  "working_hours": {
    "start": 123,
    "end": 123
  },
  "onboarded_at": "<string>",
  "created_at": "<string>"
}

{  "id": "<string>",  "org_id": "<string>",  "name": "<string>",  "sells": "<string>",  "problems": [    "<string>"  ],  "customers": [    "<string>"  ],  "domain": "<string>",  "booking_link": "<string>",  "attribution": "chatgpt",  "timezone": "<string>",  "week_start": "monday",  "working_days": [    "sunday"  ],  "working_hours": {    "start": 123,    "end": 123  },  "onboarded_at": "<string>",  "created_at": "<string>"}