Skip to main content
GET
CARF schedule and review settings

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

workflowId
string
required

Response

200 - application/json
granularity
enum<string>
required

How often a report is generated, each covering the Europe/London period that just closed. manual: only on request.

Available options:
manual,
daily,
weekly,
monthly,
quarterly,
annual
week_start
number
required

First day of a weekly period: 0 Sunday … 6 Saturday.

Required range: 0 <= x <= 6
review_required
boolean
required

Hold each report for review before it is sent; otherwise send it as soon as it is generated.

updated_at
string | null
required