Skip to main content
GET
Get an available action

Authorizations

Authorization
string
header
required

Your full Authorization header value, including the prefix: API-Key katilyst_xxxx_yourkey

Path Parameters

availableActionId
string
required

Query Parameters

maxActionDate
string<date-time>
minActionDate
string<date-time>

Response

id
string
required
Example:

"1111-111-11111-example"

projectId
string
required
Example:

"1111-111-11111-example"

name
string
required
Example:

"Take Security Awareness Course"

description
string
required
Example:

"Awarded for for completing a security awareness course."

attribute
string
required
Example:

"Points"

operator
string
required
Example:

"+"

result
string
required
Example:

"50 | Green Belt"

conditions
string
required
Example:

"When (Points > 50) AND (Belt Level = Green Belt) Stars + 50"

stateful
boolean
required
Example:

true

frequencyLimit
string
required
Example:

"Once per month"

type
string
required
Example:

"PARTICIPANT"

expirationPeriod
string
required
Example:

"6 weeks"

approvalRequired
boolean
required
Example:

false

autoAddUsers
boolean
required
Example:

true

autoAddUsersRole
string
required
Example:

"ADMIN"

timesLogged
number
required
Example:

12