Usage

GET

usage

cURL

curl --request GET \
  --url https://api.workfloo.ws/v0/usage \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.workfloo.ws/v0/usage', 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://api.workfloo.ws/v0/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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://api.workfloo.ws/v0/usage"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.workfloo.ws/v0/usage")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "timestamp": "2025-01-01T00:00:00.000Z",
  "credits_left": 900,
  "credits_granted": 1000,
  "credits_used": 100,
  "plan": {
    "name": "Starter",
    "renewal_date": "2025-02-01T00:00:00.000Z"
  }
}

Returns the current usage for the account:

credits_left: credits left for the account (current balance; credits granted - credits used),
credits_granted: credits granted for the account (total credits granted),
credits_used: credits used for the account (total credits used),
plan: plan details (name and renewal date if applicable).

This endpoint does not affect credits, but rate limits apply.

Authorizations

x-api-key

string

header

required

Response

Successful response

timestamp

string

required

Timestamp

Example:

"2025-01-01T00:00:00.000Z"

credits_left

number

required

Credits left for the account (current balance; credits granted - credits used)

Example:

900

credits_granted

number

required

Credits granted for the account (total credits granted)

Example:

1000

credits_used

number

required

Credits used for the account (total credits used)

Example:

100

plan

object

required

Plan

Show child attributes

List jobs

cURL

curl --request GET \
  --url https://api.workfloo.ws/v0/usage \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.workfloo.ws/v0/usage', 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://api.workfloo.ws/v0/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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://api.workfloo.ws/v0/usage"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.workfloo.ws/v0/usage")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "timestamp": "2025-01-01T00:00:00.000Z",
  "credits_left": 900,
  "credits_granted": 1000,
  "credits_used": 100,
  "plan": {
    "name": "Starter",
    "renewal_date": "2025-02-01T00:00:00.000Z"
  }
}

Documentation

Guides

Health and stats

Jobs

Tools

Authorizations

Response