Skip to main content
GET
List Traffic Light review

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:25

Items per page

Required range: 1 <= x <= 100
view
enum<string>
default:attention

attention = all Amber, Red and Purple; all = every active client including Green; due = review date reached

Available options:
all,
attention,
due,
red,
amber,
purple

Search company name

Maximum string length: 200
companyId
string<uuid>

Limit to one company

Response

Review list

data
object
required