Quickstart - Kua API

This walks you from zero to your first authenticated request.

Create an API key

In the dashboard, go to Settings → API keys and issue a key. The secret (kua_live_…) is shown once — copy it somewhere safe. Prefer a kua_test_… key while you build, so you work against sandbox data.

Install an SDK (optional)

You can call the API with plain HTTP, or use an official SDK.

npm install @kua/node

pip install kua

# Nothing to install — curl is enough.

Make your first request

List your payroll runs. Pass your key in the X-Api-Key header.

curl https://api.kuahr.com/v1/payroll/runs \
  -H "X-Api-Key: kua_test_your_key_here"

import { Kua } from "@kua/node";

const kua = new Kua({ apiKey: process.env.KUA_API_KEY! });
const runs = await kua.payrollRuns.list();
console.log(runs);

import os
from kua import Kua

kua = Kua(api_key=os.environ["KUA_API_KEY"])
runs = kua.payroll_runs.list()
print(runs)

<?php
$ch = curl_init("https://api.kuahr.com/v1/payroll/runs");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-Api-Key: " . getenv("KUA_API_KEY")],
]);
$runs = json_decode(curl_exec($ch), true);
print_r($runs);

A successful call returns 200 with a JSON array of runs (empty if you have none yet).

Subscribe to events

Next steps

Pay your first employee

An end-to-end walkthrough: add an employee, run payroll, receive the event.

Data model

How companies, employees, runs, wallets, and events fit together.

Authentication

Keys, scopes, and rotation.

API reference

Every endpoint, with a live “Try it” playground.

Kua API Authentication

⌘I

​Next steps

Pay your first employee

Data model

Authentication

API reference

Next steps