Get Workspace Info

Returns workspace identity, plan, and current quota utilization.

GET /workspace

Workspace info and all current quotas and utilization stats.

cURL

curl --request GET \
  --url https://app.timelines.ai/integrations/api/workspace \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.timelines.ai/integrations/api/workspace"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.timelines.ai/integrations/api/workspace', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.timelines.ai/integrations/api/workspace",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.timelines.ai/integrations/api/workspace"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.timelines.ai/integrations/api/workspace")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.timelines.ai/integrations/api/workspace")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "status": "ok",
  "data": {
    "workspace_id": "acme-inc",
    "display_name": "Acme Inc.",
    "plan": "Business",
    "messaging_quota": {
      "total": 10,
      "used": 7,
      "period_start": "2025-02-22 00:00:00 +0100",
      "period_end": "2025-02-22 00:00:00 +0100"
    },
    "api_calls_quota": {
      "total": 10,
      "used": 7,
      "period_start": "2025-02-22 00:00:00 +0100",
      "period_end": "2025-02-22 00:00:00 +0100"
    },
    "seats": {
      "total": 10,
      "used": 7,
      "period_start": "2025-02-22 00:00:00 +0100",
      "period_end": "2025-02-22 00:00:00 +0100"
    },
    "non_recurring_quota": {
      "remaining_balance": 50,
      "last_updated_at": "2025-02-22 00:00:00 +0100"
    }
  }
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

Success

status · enum<string> · required

Available options: ok, error

Example:

"ok"

data · object · required

Show child attributes