Getting started with the Roldesk API

The Roldesk REST API lets your other software read and update your workspace's data — work orders, customers, invoices, contracts, and more. It's available on the Professional plan.

1. Create an access token

Go to Settings → Developer (owner or admin only) and create a Personal Access Token. Choose the scopes it needs — for example crm:read to read customers, or work-orders:write to create jobs. Copy the token now — it's shown only once.

2. Verify it works

Send the token as a Bearer header. The /me endpoint confirms the token and shows your workspace:

curl https://www.roldesk.com/api/v1/me \
  -H "Authorization: Bearer rk_live_…"

3. Read some data

curl "https://www.roldesk.com/api/v1/work-orders?limit=25" \
  -H "Authorization: Bearer rk_live_…"

Lists are paginated: pass limit (up to 100) and the next_cursor from the previous response to get the next page. You can filter with status, account_id, and updated_since.

4. Create or update data

curl -X POST https://www.roldesk.com/api/v1/customers \
  -H "Authorization: Bearer rk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Corp", "email": "ops@acme.com"}'

Add an Idempotency-Key header to retry safely without creating duplicates.

Where to go next

• Full reference: roldesk.com/developers
• Import into Postman/Insomnia: the OpenAPI spec at /api/v1/openapi.json
• Real-time events: see the Webhooks article.