FAQ

Getting started

Is there an OpenAPI specification for the Runn API?
Yes - All Runn API v1 endpoints are available via an OpenAPI v3.1 specification.

I’m getting a 404 Not Found error — what does that mean? A 404 usually means you’re using the wrong API base URL. Check Settings → API in the Runn app to confirm the correct URL.

My API request stopped working. Why?

The most common causes are :

API rate limits being exceeded Learn more
An expired API token (Check Settings > API)

Limits & constraints

Can I delete projects or clients via the API ?
No. Deleting projects or clients isn’t supported via the API due to cascading data impacts. Use the Runn web app instead.

Can I delete people via the API?
Yes - with restrictions. Deletion will fail if the person has existing assignments or actuals, unless you use the force flag.

Assignments

Can I split an assignment into multiple date ranges via the API?
No. The API doesn’t support splitting assignments. You’ll need to delete the assignment and recreate the required segments.

Can assignments have different hours on different days?
No. Assignments use a constant number of hours per day.

If you need:

8 hours on day one
2 hours on day two

Create two separate assignments.

Why does an assignment appear in the API but not in the app?
Single-day assignments that fall on a public holiday are hidden in the UI. They’re retained in case the public holiday is later removed or changed.

People & contracts

How do I get a person's current role?
A person's role is defined in their active contract.

Can I update costs or roles from a specific date?
Yes. Create a new contract with a startDate matching when the change should apply.

Actuals & time tracking

Our time sheets live in another system. How do we import them?
See the Actuals Guide for supported import methods.

What is the best way to fetch all updated actuals?

Use the modifiedAfter query parameter along with cursor-based pagination.

High-level process:

Page through all results using cursor
Track the latest updatedAt value
Repeat future requests using modifiedAfter

For full details, see the Actuals guide.

If records change while paging, will they appear automatically?

No. Updates aren’t guaranteed to appear in later pages.

You’ll need to:

Make a new request using modifiedAfter
Omit the cursor parameter

Can I set the time off type when creating time off?
Yes. Refer to the Time offs Endpoint Guide for supported types and behaviours.

Reporting & calculations

Can I extract the project revenue and cost per month via the API?
Yes. We have a beta available for people and project metrics.