Skip to main content
GET
List credit usage
In the Heliyos MCP server: heliyos_usage_get.

Authorizations

Authorization
string
header
required

A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.

Query Parameters

limit
integer
default:20

Entries per page, 1 to 100. Defaults to 20.

Required range: 1 <= x <= 100
page
integer

The page to return, starting at 1. Defaults to 1.

Required range: x >= 1
from
string<date-time>

Only entries recorded at or after this time, as an ISO 8601 date or date-time. A date alone means midnight UTC at the start of that day.

to
string<date-time>

Only entries recorded at or before this time, as an ISO 8601 date or date-time. A date alone means midnight UTC at the start of that day, so to include a whole day send the next day's midnight or T23:59:59.999Z.

feature
string

Only entries for this feature, exact match and case-sensitive, for example worker_run or company_enrichment. See feature on the entry for the values.

Maximum string length: 100
objectId
string

Only entries charged on this object, exact match. For a worker run, pass the run id.

Maximum string length: 100

Case-insensitive text matched against feature, objectId, objectType and description. Up to 200 characters. An empty string is ignored.

Maximum string length: 200

Response

A page of usage entries.

meta
object
required
data
object[]
required