Skip to content

API reference

Machine access to pay data

Consents that let one API key, AI app, marketplace app or connector receive pay and private data, and revoking them.

3 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.

List machine access to pay data#

POST/v1/payroll/consents.listRead

The consents that let an API key, AI app, marketplace app or connector receive pay and private data (Payroll → Settings → Machine access), active and revoked. Owners, admins and HR. Part of the Payroll 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
payroll_consents_list on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • consentsobject[]required
    6 fields
    • idstringrequired
    • granteeobjectrequired
      3 fields
      • kindstringrequired
      • idstringrequired
      • namestringrequired
    • data"pay" | "private"[]required
    • granted_atstringrequired
    • revoked_atstring | nullrequired
    • activebooleanrequired
  • maxintegerrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/payroll/consents.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "consents": [
      {
        "id": "k1",
        "grantee": {
          "kind": "api_key",
          "id": "key1",
          "name": "Payroll sync"
        },
        "data": [
          "pay",
          "private"
        ],
        "granted_at": "2026-04-01T10:00:00.000Z",
        "revoked_at": null,
        "active": true
      }
    ],
    "max": 50
  }
}

Allow a machine to receive pay data#

POST/v1/payroll/consents.grantWrite

Records an owner's, admin's or HR member's consent for one API key, AI app (oauth_app), marketplace app install or connector connection to receive pay and/or private data (data: pay, private). Replaces an active consent of the same grantee. Recorded in Activity; revoke it any time. At most 50 active. In the app only.

Web app only
Refused for API keys and connected apps. Only a person signed in to Bizisy lets a machine receive pay data.
MCP tool
payroll_consents_grant on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • granteeobjectrequired
    3 fields
    • kind"api_key" | "oauth_app" | "app_install" | "connection"required
    • idstringrequired

      1–100 characters.

    • namestringrequired

      1–100 characters.

  • data"pay" | "private"[]required

    1–2 items.

Returns

  • idstringrequired
  • granteeobjectrequired
    3 fields
    • kindstringrequired
    • idstringrequired
    • namestringrequired
  • data"pay" | "private"[]required
  • granted_atstringrequired
  • revoked_atstring | nullrequired
  • activebooleanrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/payroll/consents.grant \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "grantee": {
    "kind": "api_key",
    "id": "key1",
    "name": "Payroll sync"
  },
  "data": [
    "pay",
    "private"
  ]
}'
Response
{
  "data": {
    "id": "k1",
    "grantee": {
      "kind": "api_key",
      "id": "key1",
      "name": "Payroll sync"
    },
    "data": [
      "pay",
      "private"
    ],
    "granted_at": "2026-04-01T10:00:00.000Z",
    "revoked_at": null,
    "active": true
  }
}

Stop a machine receiving pay data#

POST/v1/payroll/consents.revokeWrite

Revokes a consent (payroll_consents_list): from the next request, that API key, app or connection no longer receives pay or private data. Recorded in Activity. In the app only. Owners, admins and HR.

Web app only
Refused for API keys and connected apps. Consents are revoked in the app only.
MCP tool
payroll_consents_revoke on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • consent_idstringrequired

Returns

  • idstringrequired
  • granteeobjectrequired
    3 fields
    • kindstringrequired
    • idstringrequired
    • namestringrequired
  • data"pay" | "private"[]required
  • granted_atstringrequired
  • revoked_atstring | nullrequired
  • activebooleanrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/payroll/consents.revoke \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"consent_id":"k1"}'
Response
{
  "data": {
    "id": "k1",
    "grantee": {
      "kind": "api_key",
      "id": "key1",
      "name": "Payroll sync"
    },
    "data": [
      "pay",
      "private"
    ],
    "granted_at": "2026-04-01T10:00:00.000Z",
    "revoked_at": "2026-04-05T10:00:00.000Z",
    "active": false
  }
}

Something missing or wrong on this page? Write to hello@bizisy.com.

Developer docs