Skip to content

API reference

Account and API keys

Who you are, your API keys, your connected apps and your language.

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

My companies#

POST/v1/platform/me.companiesRead

The companies you belong to with this account (yours and outside access, such as an accountant's clients): name, address, your role there and whether it reaches Payroll. Each company is opened and signed in to on its own address. An API key or AI app is bound to one company: it gets only this one (security review: a connection to one client must not learn the others).

Who can call it
Manage key any Manage role
Me key anyone
Keys and apps
Only the company the key or app belongs to.
MCP tool
platform_me_companies on HR Assistant, My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • companiesobject[]required
    10 fields
    • org_idstringrequired
    • namestringrequired
    • slugstringrequired
    • urlstringrequired

      The company's Bizisy address (each company signs in on its own).

    • rolestringrequired

      owner, admin, hr, viewer, member, or the custom role's name.

    • externalbooleanrequired

      Outside access (an accountant, a payroll bureau).

    • access_untilstring | nullrequired
    • payrollbooleanrequired

      The role reaches Payroll there (owners, admins, HR, or a custom role with Payroll).

    • entitiesstring[] | nullrequired

      A custom role limited to some legal entities: their ids; null for all.

    • currentbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/me.companies \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "companies": [
      {
        "org_id": "o1",
        "name": "Acme Lda",
        "slug": "acme",
        "url": "https://acme.bizisy.com",
        "role": "Accountant",
        "external": true,
        "access_until": "2027-03-31T23:00:00.000Z",
        "payroll": true,
        "entities": null,
        "current": true
      }
    ]
  }
}

Who am I#

POST/v1/platform/whoamiRead

Call this first to orient yourself. Returns the signed-in user, their organization, roles and the audiences (me/manage) they can use; today and time_zone (the company's date: resolve "next Monday" or "end of the month" from it, never from your own clock); me (your own name, title and manager today; null when your login has no person record); approvals (who must approve job changes, terminations and pay changes: off, hr, manager or manager_then_hr; anything but off means a change becomes a request); app_only (what only a person signed in to Bizisy can do, with where and a link: tell the user to do those there, never look for a tool); whether Bizisy billing exists yet (billing). user.language is the language the person chose (null: they follow the company), org.language the company default (null: each browser's language).

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_whoami on My Workplace, HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

27 fields
  • userobjectrequired
    4 fields
    • idstringrequired
    • emailstringrequired
    • display_namestringrequired
    • languagestring | nullrequired
  • orgobjectrequired
    5 fields
    • idstringrequired
    • slugstringrequired
    • namestringrequired
    • languagestring | nullrequired
    • sandboxbooleanrequired

      A developer sandbox: never billed, at most 25 people.

  • rolesstring[]required
  • audiences"me" | "manage"[]required
  • person_idstring | nullrequired
  • limitedbooleanrequired

    Invited by email and not registered yet: this login sees only its own record and Get set up (no directory, org chart or company documents) until HR registers the person.

  • todaystring | nullrequired

    The company's date today (YYYY-MM-DD, in time_zone).

  • time_zonestring | nullrequired
  • meobject | nullrequired
    3 fields
    • namestringrequired
    • titlestring | nullrequired
    • managerobject | nullrequired
      2 fields
      • idstringrequired
      • namestringrequired
  • approvalsobject | nullrequired
    3 fields
    • job_changestringrequired
    • terminationstringrequired
    • pay_changestringrequired
  • app_onlyobject[]required

    Actions only a person signed in to Bizisy can do: no tool or API call does them.

    4 fields
    • toolstringrequired
    • titlestringrequired
    • wherestringrequired
    • urlstringrequired
  • billingbooleanrequired

    Billing exists (Settings → Plan & billing, platform_billing_* tools); false while billing has not started for anyone, with nothing to set up.

  • documentsbooleanrequired

    Documents is usable: the server has file storage and the company has Documents on (documents_* tools).

  • filesbooleanrequired

    File storage exists on this server (platform_storage_* tools, file fields on profiles), whatever the Documents switch.

  • equipmentbooleanrequired

    Equipment is on for the company (assets_* tools).

  • renewalsbooleanrequired

    Renewals is on for the company (org_renewals_* tools; Manage → Renewals).

  • one_on_onesbooleanrequired

    1:1s and check-ins are on for the company (org_one_on_ones_* and org_check_ins_* tools).

  • integrationsstring[]required

    The connectors this Bizisy server offers (integrations_connections_list has their state): ids such as jira, linear, asana.

  • looker_studiobooleanrequired

    The Looker Studio connector is available on this server (Integrations → Looker Studio; data_settings_get gives its link).

  • time_offbooleanrequired

    Time off is usable: on this server and on for the company (timeoff_* tools: booking, balances, approvals, public holidays).

  • time_clockbooleanrequired

    The time clock is usable: on this server and on for the company (timeclock_* tools: clocking, corrections, month close, exports); timeclock_my_today says whether the company has set it up.

  • featuresobjectrequired

    What the company switched on or off in Settings → Modules.

    3 fields
    • modulesobjectrequired

      Every module (timeoff, timeclock, documents, assets, checkins, renewals, hiring, payroll, finance, analytics, pay_equity, more_integrations, bank_verification; all included): on for the company, and offered by this server. Tools of a module that is off answer module_disabled.

    • aiobjectrequired

      AI assistants allowed per side (manage: Bizisy for HR and managers; me: My workspace). Off: connected AI apps are refused with ai_disabled.

      2 fields
      • managebooleanrequired
      • mebooleanrequired
    • apiobjectrequired

      API keys allowed per side. Off: keys are refused with api_disabled and none can be created.

      2 fields
      • managebooleanrequired
      • mebooleanrequired
  • pausedobject | nullrequired

    Set while the company is paused for unpaid invoices (or missing billing details): only owners and admins can sign in, in the web app, to pay (Settings → Plan & billing), save a card or export data; every other call is refused until every overdue invoice is paid.

    3 fields
    • reason"unpaid" | "details_missing"required
    • sincestringrequired
    • delete_onstring | nullrequired

      Set once Bizisy closed the company for it: the data is deleted on this date unless every overdue invoice is paid (or the details added) before.

  • operatorobjectrequired

    Settings only Bizisy support can change for the company (set in its admin console).

    4 fields
    • outbound_email"on" | "off"required

      off: Bizisy support turned this company's email off (a demo or test company): Bizisy records every email as not sent and sends none, except sign-in and password emails to the company's own logins. Notices still reach people in Bizisy: share invite links and other links in Bizisy, never promise an email.

    • outbound_email_sincestring | nullrequired

      When email was turned off (ISO time); null while on.

    • not_billedbooleanrequired

      Bizisy support set this company as never billed (a demo or internal company).

    • limitsobjectrequired

      Caps Bizisy support raised for this company, in force now, by limit id (api.key_requests_per_min, shifts.publishes_per_day, mail.org_daily, timeclock.import_calls_per_day); absent ids are at their default.

  • permissionsstring[]required

    What this login may do (permission names); the apps show and hide features from it.

  • accessobject | nullrequired

    Set when the login has a custom role (Settings → Roles): what it covers. null for owner, admin, hr, viewer and member.

    7 fields
    • role_idstringrequired
    • namestringrequired
    • areasobjectrequired

      A level per area: none, view, propose, edit or approve.

      13 fields
      • people"none" | "view" | "propose" | "edit" | "approve"required
      • private"none" | "view" | "propose" | "edit" | "approve"required
      • pay"none" | "view" | "propose" | "edit" | "approve"required
      • documents"none" | "view" | "propose" | "edit" | "approve"required
      • checklists"none" | "view" | "propose" | "edit" | "approve"required
      • positions"none" | "view" | "propose" | "edit" | "approve"required
      • pay_equity"none" | "view" | "propose" | "edit" | "approve"required
      • payroll"none" | "view" | "propose" | "edit" | "approve"required
      • structure"none" | "view" | "propose" | "edit" | "approve"required
      • activity"none" | "view" | "propose" | "edit" | "approve"required
      • time_off"none" | "view" | "propose" | "edit" | "approve"required
      • setup"none" | "view" | "propose" | "edit" | "approve"required
      • surveys"none" | "view" | "propose" | "edit" | "approve"required
    • scopedbooleanrequired

      The role covers some people only (its filters): you can act on those people only, and never in bulk.

    • externalbooleanrequired

      An outsider (not a worker of the company): sees only the people the role covers.

    • access_untilstring | nullrequired

      When this access ends (YYYY-MM-DD); outsiders always have one.

    • machine_sensitivebooleanrequired

      API keys and AI apps of this login may read private and pay values of the people covered.

  • partnerobject | null

    Set when this session was opened from the partner console by a partner firm's person: everything is recorded as "<you> (via <firm>)".

    5 fields
    • firmstringrequired
    • firm_idstringrequired
    • grant_idstringrequired
    • type"accountant" | "hr_consultant" | "implementation"

      The firm's partner type: its role here is Accountant, HR partner or Implementation partner.

    • expires_atstring | null

      Implementation partners: when this access ends by itself.

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/whoami \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "user": {
      "id": "usr1",
      "email": "ana@acme.test",
      "display_name": "Ana Ferreira",
      "language": null
    },
    "org": {
      "id": "o1",
      "slug": "acme",
      "name": "Acme Lda",
      "language": "pt-PT",
      "sandbox": false
    },
    "roles": [
      "owner"
    ],
    "audiences": [
      "me",
      "manage"
    ],
    "person_id": "p1",
    "today": "2026-10-07",
    "time_zone": "Europe/Lisbon",
    "me": {
      "name": "Ana Ferreira",
      "title": "Head of People",
      "manager": null
    },
    "approvals": {
      "job_change": "off",
      "termination": "off",
      "pay_change": "hr"
    },
    "app_only": [
      {
        "tool": "org_pay_add",
        "title": "Record a pay change",
        "where": "People → the person → Pay",
        "url": "https://acme.bizisy.com/manage/people"
      }
    ],
    "billing": true,
    "documents": true,
    "files": true,
    "equipment": true,
    "features": {
      "modules": {
        "timeoff": {
          "on": true,
          "available": true
        },
        "timeclock": {
          "on": true,
          "available": true
        },
        "documents": {
          "on": true,
          "available": true
        },
        "assets": {
          "on": true,
          "available": true
        },
        "checkins": {
          "on": true,
          "available": true
        },
        "renewals": {
          "on": true,
          "available": true
        }
      },
      "ai": {
        "manage": true,
        "me": true
      },
      "api": {
        "manage": true,
        "me": true
      }
    },
    "integrations": [
      "jira",
      "linear"
    ],
    "looker_studio": false,
    "time_off": false,
    "time_clock": false,
    "one_on_ones": true,
    "renewals": true,
    "paused": null,
    "operator": {
      "outbound_email": "on",
      "outbound_email_since": null,
      "not_billed": false,
      "limits": {}
    },
    "permissions": [
      "org.people.write",
      "org.read",
      "platform.self"
    ],
    "access": null,
    "limited": false
  }
}

List my sign-in methods#

POST/v1/platform/sign_in_methods.listRead

Lists the ways you can sign in to this organization: password, Google and Microsoft, each with linked (connected to your login) and available (offered on the sign-in page: Bizisy offers it and the organization has it on), plus whether your email address is confirmed (email_verified, null when unknown). Google or Microsoft is connected by the person from My profile in the web app.

Who can call it
Me key anyone
MCP tool
platform_sign_in_methods_list on My Workplace
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • methodsobject[]required
    3 fields
    • provider"password" | "google" | "microsoft"required
    • linkedbooleanrequired
    • availablebooleanrequired
  • email_verifiedboolean | nullrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/sign_in_methods.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "methods": [
      {
        "provider": "password",
        "linked": true,
        "available": true
      },
      {
        "provider": "google",
        "linked": true,
        "available": true
      },
      {
        "provider": "microsoft",
        "linked": false,
        "available": false
      }
    ],
    "email_verified": true
  }
}

List my API keys#

POST/v1/platform/api_keys.listRead

Lists your own API keys (never the secret).

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_api_keys_list on My Workplace, HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

An array of objects with 7 fields

An array of objects:

  • idstringrequired
  • namestringrequired
  • audience"me" | "manage"required
  • last4stringrequired
  • created_atstringrequired
  • last_used_atstring | nullrequired
  • revokedbooleanrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/api_keys.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": [
    {
      "id": "k1",
      "name": "Claude Code",
      "audience": "manage",
      "last4": "cdef",
      "created_at": "2026-10-04T10:00:00.000Z",
      "last_used_at": null,
      "revoked": false
    }
  ]
}

Revoke an API key#

POST/v1/platform/api_keys.revokeDestructive

Revokes one of your API keys immediately. Clients using it lose access.

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_api_keys_revoke on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • idstringrequired

Returns

  • idstringrequired
  • revokedtruerequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/api_keys.revoke \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"k1"}'
Response
{
  "data": {
    "id": "k1",
    "revoked": true
  }
}

List connected apps#

POST/v1/platform/connections.listRead

Lists the AI apps (MCP clients) connected to Bizisy by signing in: their name, where they come from, Me or Manage, when connected and last used. Your own by default; in Manage, owners and admins may pass everyone=true for the whole company (with who connected each). Tokens are never shown. A connection disconnects on its own after 30 days without use.

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_connections_list on My Workplace, HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • everyoneboolean

    Owners and admins in Manage: the whole company.

Returns

An array of objects with 12 fields

An array of objects:

  • idstringrequired
  • client_namestringrequired
  • client_kind"cimd" | "dcr"required
  • client_hoststring | nullrequired

    For apps that publish their identity (e.g. claude.ai): the host it is published on.

  • redirect_hoststringrequired
  • redirect_kind"web" | "local" | "app"required
  • audience"me" | "manage"required
  • created_atstringrequired
  • last_used_atstring | nullrequired
  • expires_atstring | nullrequired

    Disconnects on its own if unused until then (renewed on every use).

  • minebooleanrequired
  • userobject | nullrequired

    Who connected it (only in the everyone view).

    3 fields
    • idstringrequired
    • namestringrequired
    • emailstringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/connections.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"everyone":true}'
Response
{
  "data": [
    {
      "id": "g1",
      "client_name": "Claude",
      "client_kind": "cimd",
      "client_host": "claude.ai",
      "redirect_host": "claude.ai",
      "redirect_kind": "web",
      "audience": "manage",
      "created_at": "2026-10-05T10:00:00.000Z",
      "last_used_at": "2026-10-05T11:00:00.000Z",
      "expires_at": "2026-11-04T11:00:00.000Z",
      "mine": true,
      "user": {
        "id": "usr1",
        "name": "Ana Ferreira",
        "email": "ana@acme.test"
      }
    }
  ]
}

Disconnect an app#

POST/v1/platform/connections.revokeDestructive

Disconnects a connected AI app at once: its tokens stop working and it must ask again to reconnect. Your own connections; owners and admins may disconnect anyone's, but only in the web app (over MCP or an API key, your own only). Take id from platform_connections_list.

Who can call it
Manage key any Manage role
Me key anyone
Keys and apps
Only your own connections (owners and admins disconnect others in the app).
MCP tool
platform_connections_revoke on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • idstringrequired

    1–64 characters.

Returns

  • idstringrequired
  • revokedtruerequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/connections.revoke \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"g1"}'
Response
{
  "data": {
    "id": "g1",
    "revoked": true
  }
}

AI setup status#

POST/v1/platform/ai.onboarding.statusRead

For the caller only, in this audience: whether the "Connect your AI" journey applies to them (eligible: owners and admins in Manage, everyone in Me) and should show first (show), their own connected apps here with when each first called Bizisy, first made a change and the last tool it used, and the latest change or preview one of their apps made (Activity summary and links). The Bizisy app polls it while someone connects an assistant. Never shows other people's apps or activity.

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_ai_onboarding_status on My Workplace, HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

8 fields
  • eligiblebooleanrequired

    Manage: owners and admins. Me: everyone.

  • showbooleanrequired

    The journey is still open for you: eligible, no connected app of your own here yet, not put off.

  • redirectbooleanrequired

    Manage Home opens the journey first: only for a company created since the journey shipped, once per person (until they have seen it), with no connected app and no API key in use.

  • stateobjectrequired
    3 fields
    • viewed_atstring | nullrequired
    • assistant"claude" | "chatgpt" | "cursor" | "vscode" | "gemini" | "other"required
    • skipped_atstring | nullrequired
  • appsobject[]required
    9 fields
    • idstringrequired
    • client_namestringrequired
    • assistant"claude" | "chatgpt" | "cursor" | "vscode" | "gemini" | "other"required
    • connected_atstringrequired
    • last_used_atstring | nullrequired
    • first_call_atstring | nullrequired

      Its first tool call.

    • first_write_atstring | nullrequired

      Its first applied change.

    • last_toolobject | nullrequired
      2 fields
      • idstringrequired
      • titlestringrequired
    • last_tool_atstring | nullrequired
  • first_call_atstring | nullrequired
  • first_write_atstring | nullrequired
  • latestobject | nullrequired
    6 fields
    • activity_idstringrequired
    • summarystringrequired
    • previewbooleanrequired

      A preview (dry run): nothing was saved.

    • appstring | nullrequired
    • atstringrequired
    • linksobject[]required
      2 fields
      • labelstringrequired
      • pathstringrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/ai.onboarding.status \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "eligible": true,
    "show": false,
    "redirect": false,
    "state": {
      "viewed_at": "2026-10-05T10:00:00.000Z",
      "assistant": "claude",
      "skipped_at": null
    },
    "apps": [
      {
        "id": "g1",
        "client_name": "Claude",
        "assistant": "claude",
        "connected_at": "2026-10-05T10:02:00.000Z",
        "last_used_at": "2026-10-05T10:03:00.000Z",
        "first_call_at": "2026-10-05T10:02:30.000Z",
        "first_write_at": "2026-10-05T10:05:00.000Z",
        "last_tool": {
          "id": "org.setup.apply",
          "title": "Apply a company setup"
        },
        "last_tool_at": "2026-10-05T10:05:00.000Z"
      }
    ],
    "first_call_at": "2026-10-05T10:02:30.000Z",
    "first_write_at": "2026-10-05T10:05:00.000Z",
    "latest": {
      "activity_id": "01k0000000000000000000000a",
      "summary": "Applied company setup: 3 people created",
      "preview": false,
      "app": "Claude",
      "at": "2026-10-05T10:05:00.000Z",
      "links": [
        {
          "label": "People",
          "path": "/manage/people"
        }
      ]
    }
  }
}

My two-step sign-in#

POST/v1/platform/me.two_stepRead

Your two-step sign-in: the company's rule (level) and whether it includes you, whether your login has a password and a confirmed email (needed for an authenticator app), whether your current sign-in had a second step, and your authenticator apps. Authenticator apps are added and removed in the Bizisy app (My profile → Two-step sign-in), never through an API key or an AI app.

Web app only
Refused for API keys and connected apps. Two-step sign-in is managed in the Bizisy app (My profile → Two-step sign-in).
MCP tool
platform_me_two_step on My Workplace, HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • level"off" | "admins" | "hr" | "everyone"required

    The company's rule: who must sign in with two steps.

  • requiredbooleanrequired

    Whether the rule includes you.

  • password_loginbooleanrequired

    Your login has a password (authenticator apps protect password sign-ins; Google and Microsoft sign-ins use their own).

  • email_verifiedbooleanrequired

    An authenticator app needs a confirmed email address first.

  • signed_in_with_two_stepsbooleanrequired

    Your current sign-in had a second step.

  • factorsobject[]required

    Your authenticator apps (never their secrets).

    3 fields
    • uidstringrequired
    • display_namestring | nullrequired
    • enrolled_atstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/me.two_step \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "level": "admins",
    "required": true,
    "password_login": true,
    "email_verified": true,
    "signed_in_with_two_steps": true,
    "factors": [
      {
        "uid": "f1",
        "display_name": "Phone",
        "enrolled_at": "2026-10-17T10:00:00.000Z"
      }
    ]
  }
}

Record a change to my authenticator apps#

POST/v1/platform/me.two_step.changedWrite

Called by the Bizisy app right after you added or removed an authenticator app (the change itself is made with Google Identity Platform in your browser): Bizisy reads your authenticator apps again, records the change in Activity and emails you about it. Refused when nothing changed. In the app only.

Web app only
Refused for API keys and connected apps. Two-step sign-in is managed in the Bizisy app (My profile → Two-step sign-in).
MCP tool
platform_me_two_step_changed on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • change"added" | "removed"required

Returns

  • factorsobject[]required
    3 fields
    • uidstringrequired
    • display_namestring | nullrequired
    • enrolled_atstring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/me.two_step.changed \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"change":"added"}'
Response
{
  "data": {
    "factors": [
      {
        "uid": "f1",
        "display_name": "Phone",
        "enrolled_at": "2026-10-17T10:00:00.000Z"
      }
    ]
  }
}

Change my language#

POST/v1/platform/language.set_mineWrite

Sets the language Bizisy uses for you: the web app (Me and Manage, on every device and in every company you belong to) and the emails you receive. Languages: en (English), pt-PT (Português), es-ES (Español), de-DE (Deutsch), fr-FR (Français), it-IT (Italiano). null = follow the company default (or, without one, the browser's language). Any signed-in person, for themselves only. platform_whoami returns the current choice (user.language) and the company default (org.language).

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_language_set_mine on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • language"en" | "pt-PT" | "es-ES" | "de-DE" | "fr-FR" | "it-IT"required

    One of en, pt-PT, es-ES, de-DE, fr-FR, it-IT, or null to follow the company default.

Returns

  • language"en" | "pt-PT" | "es-ES" | "de-DE" | "fr-FR" | "it-IT"required

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/language.set_mine \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"language":"de-DE"}'
Response
{
  "data": {
    "language": "de-DE"
  }
}

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

Developer docs