Overview

The Redlist REST API reads and updates the records in a Redlist account: work orders, tasks, assets, forms and more. Every endpoint is listed in the API reference, where you can try it with your own key.

Authentication

Every request sends three headers from an API key. A key belongs to one Redlist account; it can't span accounts, so an integration that works across accounts needs a key for each.

To check a key works, call GET api/Me. It returns the account and integration the key belongs to and what it's allowed to do.

Your first request

Pagination

Every GET that returns a list pages the same way. With no parameters you get the first 25 records.

• take: how many records to return. Default 25, maximum 1,000.

• skip: how many records to skip. Default 0. Use with take to page through results.

• orderby: one or more properties to sort by, comma-separated, each optionally followed by a space and Asc or Desc (for example Name,CreatedOn Desc). Ascending if not given.

Filtering

Filter any list by passing a property name as a query parameter. By default the value must match exactly. Records with a Deleted flag are left out unless you pass Deleted=true.

• fuzzy=true: match values that contain the text instead. ?fuzzy=true&Description=lube finds every task whose description contains "lube".

• extFilter=true: compare instead of matching. Add a space and an operator after the value: ne (not equal), gt (greater than), ge (greater or equal), lt (less than) or le (less or equal). extFilter overrides fuzzy.

Updating records

PATCH endpoints take a JSON Patch document, sent with Content-Type: application/json-patch+json. Only the fields you name change. For example, to rename a task:

Next

• Browse every endpoint in the API reference

• Rate limits & errors

• Get notified of changes with webhooks

• Read related records in one request with GraphQL

Next: Create an API key →