Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

OK

id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
name
string
required

Name of the application.

createdBy
any
required

Circular reference to User

description
string
required

Description of the application.

Maximum string length: 2000
color
string
required

Icon color of the application.

icon
enum<string>
required

Icon type of the application.

Available options:
fa-bookmark, fa-bolt, fa-bullhorn, fa-certificate,fa-check-square-o, fa-cloud, fa-comments, fa-dollar, fa-exclamation-triangle, fa-file-text-o,fa-folder, fa-gift, fa-globe, fa-heartbeat, fa-leaf, fa-legal, fa-life-ring, fa-medkit, fa-money,fa-percent, fa-rocket, fa-signal, fa-university, fa-user-circle
type
string
required
sourceApplicationId
string
required
sourceEnvironment
string
required
permissionsEnabled
boolean
required
imported
boolean
required
copied
boolean
required
live
boolean
required
currency
enum<string>
required
Available options:
EUR,
GBP,
USD
uxriEnabled
boolean
required

Whether or not UXRI is enabled on this application.

shortCode
string
required

Short display code for the application in navigation.

Pattern: ^(?! +$)[a-zA-Z0-9 ]{1,10}$
workflows
any[]
required

Workflows associated to the application.

Circular reference to Workflow

defaultHomeScreen
object
required