API reference
Data and BI
The analytics dataset Bizisy delivers to data tools (its schema and version), the OData feed's address and BI token status, pay sharing, and each export destination's last delivery. Exports themselves are connected tools (BigQuery, Cloud Storage, S3, Azure Blob). Creating the BI token and sharing pay happen in the web app.
5 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
Data and BI settings#
POST/v1/data/settings.getRead
What this company shares with data and BI tools: the OData feed address for Power BI and Excel (feed_url), whether a BI token exists (its last four characters, when it was made and last used; the token itself is shown only once, when created), whether pay is shared (pay.shared: off unless an owner, admin or HR member turned it on in Bizisy), whether Looker Studio is available, the dataset schema version, the federation details a cloud needs to trust Bizisy (issuer, this company's audience and subject; null when this server does not offer keyless delivery) and each export destination's last delivery. Owners, admins and HR. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules); this read of stored data keeps working while it is off.
- Who can call it
- Manage key owner admin hr
- MCP tool
data_settings_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
7 fields
feed_urlstringrequiredtokenobject | nullrequired3 fields
last4stringrequiredcreated_atstringrequiredlast_used_atstring | nullrequired
payobjectrequired2 fields
sharedbooleanrequiredchanged_atstring | nullrequired
looker_studioobjectrequired2 fields
availablebooleanrequiredurlstring | nullrequired
federationobject | nullrequired3 fields
issuerstringrequiredaudiencestringrequiredsubjectstringrequired
schema_versionintegerrequiredexportsobject[]required8 fields
connectorstringrequiredlast_slotstring | nullrequiredlast_delivered_atstring | nullrequiredrowsintegerrequiredbytesintegerrequiredtablesintegerrequiredformatstring | nullrequiredlocationstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/data/settings.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/data/settings.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/data/settings.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"feed_url": "https://api.bizisy.com/odata/v1/",
"token": {
"last4": "x7Qa",
"created_at": "2026-10-03T09:12:00.000Z",
"last_used_at": "2026-10-04T08:00:00.000Z"
},
"pay": {
"shared": false,
"changed_at": null
},
"looker_studio": {
"available": true,
"url": "https://lookerstudio.google.com/datasources/create?connectorId=AKfycb-example"
},
"federation": {
"issuer": "https://api.bizisy.com/federation",
"audience": "https://api.bizisy.com/federation/org/o1",
"subject": "org:o1"
},
"schema_version": 1,
"exports": [
{
"connector": "gcs",
"last_slot": "2026-10-04",
"last_delivered_at": "2026-10-04T05:00:12.000Z",
"rows": 1240,
"bytes": 318000,
"tables": 9,
"format": "parquet",
"location": "gs://acme-hr/bizisy"
}
]
}
}Data export schema#
POST/v1/data/schema.getRead
The analytics dataset Bizisy delivers to data tools (exports to BigQuery, Cloud Storage, S3, Azure Blob; the OData feed; Looker Studio): its version and tables (people as of a day, jobs history, teams, locations, legal entities, positions, monthly headcount, headcount by team, checklists, and pay only while pay sharing is on), each with its key and columns (name, type: string, date, integer, number, boolean, timestamp; custom: this company's own custom fields of public and job tier). Private details are never in it, and nothing planned after the day it describes. Owners, admins and HR. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules); this read of stored data keeps working while it is off.
- Who can call it
- Manage key owner admin hr
- MCP tool
data_schema_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
schema_versionintegerrequiredpaybooleanrequiredtablesobject[]required4 fields
namestringrequireddescriptionstringrequiredkeystring[]requiredcolumnsobject[]required4 fields
namestringrequiredtype"string" | "date" | "integer" | "number" | "boolean" | "timestamp"requireddescriptionstringrequiredcustomboolean
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/data/schema.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/data/schema.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/data/schema.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"schema_version": 1,
"pay": false,
"tables": [
{
"name": "people",
"description": "One row per person employed on as_of, with their job that day.",
"key": [
"person_id"
],
"columns": [
{
"name": "person_id",
"type": "string",
"description": "Person id (stable)."
},
{
"name": "start_date",
"type": "date",
"description": "First day of the current employment."
},
{
"name": "fte",
"type": "number",
"description": "Full-time equivalent (1 = full time)."
},
{
"name": "custom_shirt_size",
"type": "string",
"description": "Custom field \"Shirt size\" (select).",
"custom": true
}
]
}
]
}
}Create a BI token#
POST/v1/data/feed.token_createWrite
Creates the company's BI token for Power BI, Excel and Looker Studio (read-only: it can only read the analytics dataset through the OData feed; never anyone's private details, pay only while pay sharing is on). The token is shown once in the result: copy it into the BI tool (Power BI and Excel: Basic, any user name, the token as password). A company has one: creating another replaces it and the old one stops working at once. Owners and admins, in the app only. Part of the Reports & analytics module (included): companies with it switched off get module_disabled (an owner or admin switches it on in Manage → Settings → Modules).
- Web app only
- Refused for API keys and connected apps. An owner or admin creates the BI token in the app (Integrations → Power BI and Excel → Access): it is shown once there.
- MCP tool
data_feed_token_createon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
No input: send {}.
Returns
tokenstringrequiredShown once.
last4stringrequiredreplacedbooleanrequiredfeed_urlstringrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/data/feed.token_create \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/data/feed.token_create', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/data/feed.token_create",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"token": "bzbi_o1_shown-once-copy-it-now",
"last4": "x7Qa",
"replaced": false,
"feed_url": "https://api.bizisy.com/odata/v1/"
}
}Revoke the BI token#
POST/v1/data/feed.token_revokeDestructive
Revokes the company's BI token: Power BI, Excel and Looker Studio reports using it stop refreshing at once (what they already loaded stays in them). Owners and admins, in the app only.
- Web app only
- Refused for API keys and connected apps. Revoking the BI token happens in the app.
- MCP tool
data_feed_token_revokeon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
No input: send {}.
Returns
revokedtruerequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/data/feed.token_revoke \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/data/feed.token_revoke', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/data/feed.token_revoke",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"revoked": true
}
}Share pay with data tools#
POST/v1/data/pay.setWrite
Turns pay sharing with data tools on or off (share). On: exports and the BI feed include the pay table (everyone's pay history) and positions' pay ranges, to every destination this company connected and every report that uses the BI token. Off (the default): they never contain pay. Takes effect at the next delivery or refresh; files already delivered keep what they had. Recorded in Activity. Owners, admins and HR, in the app only.
- Web app only
- Refused for API keys and connected apps. Sharing pay with data tools is a person's choice in the app (Integrations → Power BI and Excel → Access), recorded in Activity.
- MCP tool
data_pay_seton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
sharebooleanrequired
Returns
sharedbooleanrequiredchangedbooleanrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/data/pay.set \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"share":false}'const res = await fetch('https://api.bizisy.com/v1/data/pay.set', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"share": false
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/data/pay.set",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"share": False,
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"shared": true,
"changed": true
}
}Something missing or wrong on this page? Write to hello@bizisy.com.