CardOffice documentation

Start with what you are doing

Integrating a system

Create card holders, upload photos, place orders and react to events. Begin with the quickstart, then the API reference and webhooks.

Connecting your directory

Sign staff in with Entra ID, Google Workspace or Okta and keep the roster current with SCIM.

Setting up printing

Install the print agent for a Zebra ZXP Series 7 and get past Windows download warnings.

Issuing cards every day

The staff guide, the print room guide and what to send card holders.

Your first request

curl -sS "https://app.cardoffice.nz/api/v1/card-holders?pageSize=5" \
  -H "Authorization: Bearer $CARDOFFICE_KEY"

{
  "data": [ { "id": "0b5e4c1a-…", "firstName": "Emma", "lastName": "Hall", "status": "active" } ],
  "meta": { "page": 1, "pageSize": 5, "total": 312 }
}

Create a key under Settings → Integrations. The quickstart takes you from there to a placed order.

Reference at a glance

Base URL	https://app.cardoffice.nz/api/v1
Authentication	Authorization: Bearer idp_… API key with scopes
Format	JSON over HTTPS
Rate limit	120 requests per minute per API key
Webhooks	HMAC-SHA256 signed, timestamped, retried with backoff
Directory provisioning	SCIM 2.0
Status	app.cardoffice.nz/status

Machine-readable API descriptionDownload the OpenAPI 3.1 file for the public REST API.