Quickstart

Create a Test key

Open the Kua dashboard, select the intended company and go to Developer → API keys. Complete the required identity confirmation and issue a Test key with payroll:read. Store the one-time secret in your secret manager.

If you cannot issue a key or the workspace is not approved, ask the company Owner or an authorised administrator to resolve access. A key with no scopes cannot read scoped endpoints. Keep this tutorial on a Test key.

Make the request

Set KUA_API_KEY in your local environment to that Test secret. Do not paste a real key into source code or commit it. Call https://api.kuahr.com; the Test key selects isolated Test records.

curl --fail-with-body https://api.kuahr.com/v1/payroll/runs \
  -H "X-Api-Key: $KUA_API_KEY"

// Install the official SDK first: see /sdks/node.
import { Kua } from "@kuahr/node";
const kua = new Kua({
  apiKey: process.env.KUA_API_KEY!,
});
console.log(await kua.payrollRuns.list());

# Install the official SDK first: see /sdks/python.
import os
from kua import Kua
with Kua(
    api_key=os.environ["KUA_API_KEY"],
) as kua:
    print(kua.payroll_runs.list())

cURL needs no SDK. For the optional language examples, install Node or Python from npm or PyPI.

Check the response

A successful request returns HTTP 200 and a JSON array. An empty array is a valid result:

[]

A non-empty array contains only this company’s Test runs. It does not include Live payroll runs. Save a redacted status/result in your integration log; do not log the API key.

Choose what to build next

Your first request is complete. Continue with a Test payroll draft, employee creation, or the Test and Live key guide. Events and webhooks require a separate, authorised Live-key integration; they are not the next step in this Test tutorial.