Usage

There are many ways to make HTTP calls to the Runn API. We do not provide an official SDK for different programming languages. Every language will have capable HTTP clients to get you started.

Here’s how you would make a request to get all clients in your account with the popular curl command line utility.

curl \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept-Version: 1.0.0' \
  https://api.runn.io/clients

All endpoints for writing data via the API accept request bodies in JSON format. Here’s how you would update an existing client with id=123:

curl \
  -X PATCH \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept-Version: 1.0.0' \
  -H 'Content-Type: application/json' \
  -d '{"name": "My updated name"}' \
	https://api.runn.io/clients/123

Refer to the OpenAPI documentation for available endpoints and detailed request body format.

Generally speaking, the API will only update properties passed into the request body, and retain omitted properties on existing records.

In order to explicitly unset properties, pass in the appropriate “null” format for the property (null, "", []). When creating records, properties may be left out unless they are required.