docs.jsonld
type: ApiDocumentation
entrypoint: /api
supported class: MediaObject
supported class: ExternalUser
supported class: User
supported class: Company
supported class: UserCompanyProfile
supported class: Dashboard
supported class: DashboardUser
supported class: Team
supported class: Role
supported class: Application
supported class: UserDevice
supported class: Integration
supported class: BambooHr
supported class: WhiteListIp
supported class: Compliance
supported class: Country
supported class: Language
supported class: CompanySubscription
supported class: SignUpPage
supported class: Onboarding
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

MediaObject
type: Class
title: MediaObject
supported operation: Retrieves MediaObject resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves MediaObject resource.
  returns: MediaObject

ExternalUser
type: Class
title: ExternalUser
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsappPhone
  title: whatsappPhone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeZone
  title: timeZone
  required: false
  readable: true
  writeable: true
supported operation: Retrieves ExternalUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ExternalUser resource.
  returns: ExternalUser
supported operation: Updates the ExternalUser resource.
  type: Operation
  expects: ExternalUser
  method: PATCH
  title: Updates the ExternalUser resource.
  returns: ExternalUser

email
type: Property
domain: ExternalUser
range: string

fullName
type: Property
domain: ExternalUser
range: string

phone
type: Property
domain: ExternalUser
range: string

whatsappPhone
type: Property
domain: ExternalUser
range: string

timeZone
type: Property
domain: ExternalUser
range: string

User
type: Class
title: User
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: displayName
  title: displayName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: imageName
  title: imageName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: profileImage
  title: profileImage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeZone
  title: timeZone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: summary
  title: summary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: provider
  title: provider
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: seoName
  title: seoName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastLogin
  title: lastLogin
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: twoFactorAuthEnabled
  title: twoFactorAuthEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userRoles
  title: userRoles
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: tokenUpdatedAt
  title: tokenUpdatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: providerName
  title: providerName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: initials
  title: initials
  required: false
  readable: true
  writeable: false
supported operation: Retrieves User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Retrieves the collection of UserCompanyProfile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserCompanyProfile resources.
  returns: UserCompanyProfile
supported operation: Retrieves the collection of DashboardUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DashboardUser resources.
  returns: DashboardUser
supported operation: Retrieves the collection of UserDevice resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserDevice resources.
  returns: UserDevice

email
type: Property
domain: User
range: string
domain: Company
label: hrEmail
domain: Dashboard

fullName
type: Property
domain: User
range: string

displayName
type: Property
domain: User
range: string

password
type: Property
domain: User
range: string

imageName
type: Property
domain: User
range: string

profileImage
type: Property
domain: User
max cardinality: 1
range: MediaObject

phone
type: Property
domain: User
range: string

timeZone
type: Property
domain: User
range: string

summary
type: Property
domain: User
range: string

description
type: Property
domain: User
range: string

provider
type: Property
domain: User
range: integer

seoName
type: Property
domain: User
range: string

lastLogin
type: Property
domain: User
range: dateTime

country
type: Property
domain: User
max cardinality: 1
range: Country

language
type: Property
domain: User
max cardinality: 1
range: Language

twoFactorAuthEnabled
type: Property
domain: User
range: boolean

userRoles
type: Property
domain: User
range: Role

tokenUpdatedAt
type: Property
domain: User
range: dateTime

providerName
type: Property
domain: User
range: string

initials
type: Property
domain: User
range: string

Company
type: Class
title: Company
supported property: SupportedProperty
  property: domain
  title: domain
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: summary
  title: summary
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: whatsAppPhone
  title: whatsAppPhone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subDomain
  title: subDomain
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: hrEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: seoName
  title: seoName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enableRemoteLogging
  title: enableRemoteLogging
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isCameraMandatory
  title: isCameraMandatory
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: cameraMandatory
  title: cameraMandatory
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Company resource.
  returns: Company
supported operation: Creates a Company resource.
  type: Operation
  type: CreateAction
  expects: Company
  method: POST
  title: Creates a Company resource.
  returns: Company
supported operation: Creates a Company resource.
  type: Operation
  type: CreateAction
  expects: Company
  method: POST
  title: Creates a Company resource.
  returns: Company
supported operation: Updates the Company resource.
  type: Operation
  expects: Company
  method: PATCH
  title: Updates the Company resource.
  returns: Company
supported operation: Updates the Company resource.
  type: Operation
  expects: Company
  method: PATCH
  title: Updates the Company resource.
  returns: Company
supported operation: Deletes the Company resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Company resource.
  returns: Nothing
supported operation: Retrieves Company resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Company resource.
  returns: Company
supported operation: Creates a Company resource.
  type: Operation
  type: CreateAction
  expects: Company
  method: POST
  title: Creates a Company resource.
  returns: Company
supported operation: Retrieves the collection of Dashboard resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Dashboard resources.
  returns: Dashboard
supported operation: Retrieves the collection of Team resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Team resources.
  returns: Team
supported operation: Retrieves the collection of WhiteListIp resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WhiteListIp resources.
  returns: WhiteListIp

domain
type: Property
domain: Company
range: string

name
type: Property
domain: Company
range: string

logo
type: Property
domain: Company
range: string

summary
type: Property
domain: Company
range: string

createdBy
type: Property
domain: Company
max cardinality: 1
range: User

whatsAppPhone
type: Property
domain: Company
range: string

subDomain
type: Property
domain: Company
range: string

seoName
type: Property
domain: Company
range: string

enableRemoteLogging
type: Property
domain: Company
range: boolean

isCameraMandatory
type: Property
domain: Company
range: boolean

cameraMandatory
type: Property
domain: Company
range: boolean

UserCompanyProfile
type: Class
title: UserCompanyProfile
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: teams
  title: teams
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported operation: Retrieves UserCompanyProfile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserCompanyProfile resource.
  returns: UserCompanyProfile
supported operation: Retrieves UserCompanyProfile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserCompanyProfile resource.
  returns: UserCompanyProfile
supported operation: Updates the UserCompanyProfile resource.
  type: Operation
  expects: UserCompanyProfile
  method: PATCH
  title: Updates the UserCompanyProfile resource.
  returns: UserCompanyProfile
supported operation: Deletes the UserCompanyProfile resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the UserCompanyProfile resource.
  returns: Nothing

roles
type: Property
domain: UserCompanyProfile
range: Role

teams
type: Property
domain: UserCompanyProfile
range: Team

enabled
type: Property
domain: UserCompanyProfile
range: boolean

Dashboard
type: Class
title: Dashboard
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
  description: Required if email is enabled
supported property: SupportedProperty
  property: whatsAppPhone
  title: whatsAppPhone
  required: false
  readable: true
  writeable: true
  description: Required if whatsapp is enabled
supported property: SupportedProperty
  property: whatsAppEnabled
  title: whatsAppEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailEnabled
  title: emailEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: videoCallEnabled
  title: videoCallEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: calendarEnabled
  title: calendarEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workbot
  title: workbot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: seoName
  title: seoName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: videoCallAlertTime
  title: videoCallAlertTime
  required: false
  readable: true
  writeable: true
  description: The time after which video request should be highlighted (In minutes)
supported property: SupportedProperty
  property: chatEnabled
  title: chatEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: themeColor
  title: themeColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: messagePlaceholder
  title: messagePlaceholder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: suggestedMessages
  title: suggestedMessages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: footer
  title: footer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: attachmentEnabled
  title: attachmentEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: requireUserInfoEnabled
  title: requireUserInfoEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: defaultThemeColor
  title: defaultThemeColor
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Dashboard resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Dashboard resource.
  returns: Dashboard
supported operation: Updates the Dashboard resource.
  type: Operation
  expects: Dashboard
  method: PATCH
  title: Updates the Dashboard resource.
  returns: Dashboard
supported operation: Deletes the Dashboard resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Dashboard resource.
  returns: Nothing
supported operation: Creates a Dashboard resource.
  type: Operation
  type: CreateAction
  expects: Dashboard
  method: POST
  title: Creates a Dashboard resource.
  returns: Dashboard
supported operation: Retrieves the collection of DashboardUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DashboardUser resources.
  returns: DashboardUser

title
type: Property
domain: Dashboard
range: string

description
type: Property
domain: Dashboard
range: string

whatsAppPhone
type: Property
domain: Dashboard
range: string

whatsAppEnabled
type: Property
domain: Dashboard
range: boolean

emailEnabled
type: Property
domain: Dashboard
range: boolean

videoCallEnabled
type: Property
domain: Dashboard
range: boolean

calendarEnabled
type: Property
domain: Dashboard
range: boolean

workbot
type: Property
domain: Dashboard
range: boolean

seoName
type: Property
domain: Dashboard
range: string

logo
type: Property
domain: Dashboard
max cardinality: 1
range: MediaObject

videoCallAlertTime
type: Property
domain: Dashboard
range: integer

chatEnabled
type: Property
domain: Dashboard
range: boolean

themeColor
type: Property
domain: Dashboard
range: string

messagePlaceholder
type: Property
domain: Dashboard
range: string

suggestedMessages
type: Property
domain: Dashboard
range: string

footer
type: Property
domain: Dashboard
range: string

attachmentEnabled
type: Property
domain: Dashboard
range: boolean

requireUserInfoEnabled
type: Property
domain: Dashboard
range: boolean

defaultThemeColor
type: Property
domain: Dashboard
range: string

DashboardUser
type: Class
title: DashboardUser
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: schedulingEnabled
  title: schedulingEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailEnabled
  title: emailEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: videoCallEnabled
  title: videoCallEnabled
  required: false
  readable: true
  writeable: true
supported operation: Retrieves DashboardUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves DashboardUser resource.
  returns: DashboardUser
supported operation: Updates the DashboardUser resource.
  type: Operation
  expects: DashboardUser
  method: PATCH
  title: Updates the DashboardUser resource.
  returns: DashboardUser
supported operation: Deletes the DashboardUser resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the DashboardUser resource.
  returns: Nothing

user
type: Property
domain: DashboardUser
max cardinality: 1
range: User

schedulingEnabled
type: Property
domain: DashboardUser
range: boolean

emailEnabled
type: Property
domain: DashboardUser
range: boolean

videoCallEnabled
type: Property
domain: DashboardUser
range: boolean

Team
type: Class
title: Team
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Team resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Team resource.
  returns: Team
supported operation: Updates the Team resource.
  type: Operation
  expects: Team
  method: PATCH
  title: Updates the Team resource.
  returns: Team
supported operation: Deletes the Team resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Team resource.
  returns: Nothing
supported operation: Creates a Team resource.
  type: Operation
  type: CreateAction
  expects: Team
  method: POST
  title: Creates a Team resource.
  returns: Team
supported operation: Deletes the Team resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Team resource.
  returns: Nothing
supported operation: Retrieves the collection of UserCompanyProfile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserCompanyProfile resources.
  returns: UserCompanyProfile

title
type: Property
domain: Team
range: string

description
type: Property
domain: Team
range: string

Role
type: Class
title: Role
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: application
  title: application
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Role resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Role resource.
  returns: Role

name
type: Property
domain: Role
range: string

description
type: Property
domain: Role
range: string

application
type: Property
domain: Role
max cardinality: 1
range: Application

Application
type: Class
title: Application
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: alias
  title: alias
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: logo
  title: logo
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: favicon
  title: favicon
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Application resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Application resource.
  returns: Application
supported operation: Retrieves the collection of UserDevice resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserDevice resources.
  returns: UserDevice

name
type: Property
domain: Application
range: string

alias
type: Property
domain: Application
range: string

slug
type: Property
domain: Application
range: string

logo
type: Property
domain: Application
range: string

favicon
type: Property
domain: Application
range: string

UserDevice
type: Class
title: UserDevice
supported property: SupportedProperty
  property: application
  title: application
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: deviceToken
  title: deviceToken
  required: false
  readable: true
  writeable: true
supported operation: Retrieves UserDevice resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserDevice resource.
  returns: UserDevice
supported operation: Updates the UserDevice resource.
  type: Operation
  expects: UserDevice
  method: PATCH
  title: Updates the UserDevice resource.
  returns: UserDevice
supported operation: Deletes the UserDevice resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the UserDevice resource.
  returns: Nothing

application
type: Property
domain: UserDevice
max cardinality: 1
range: Application

deviceToken
type: Property
domain: UserDevice
range: string

Integration
type: Class
title: Integration
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: settings
  title: settings
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updated
  title: updated
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Integration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Integration resource.
  returns: Integration
supported operation: Updates the Integration resource.
  type: Operation
  expects: Integration
  method: PATCH
  title: Updates the Integration resource.
  returns: Integration

type
type: Property
domain: Integration
range: integer

settings
type: Property
domain: Integration

company
type: Property
domain: Integration
max cardinality: 1
range: Company

updated
type: Property
domain: Integration
range: dateTime

BambooHr
type: Class
title: BambooHr
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: apiKey
  title: apiKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subDomain
  title: subDomain
  required: false
  readable: true
  writeable: true
supported operation: Retrieves BambooHr resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves BambooHr resource.
  returns: BambooHr
supported operation: Updates the BambooHr resource.
  type: Operation
  expects: BambooHr
  method: PATCH
  title: Updates the BambooHr resource.
  returns: BambooHr

company
type: Property
domain: BambooHr
max cardinality: 1
range: Company

apiKey
type: Property
domain: BambooHr
range: string

subDomain
type: Property
domain: BambooHr
range: string

WhiteListIp
type: Class
title: WhiteListIp
supported property: SupportedProperty
  property: company
  title: company
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ip
  title: ip
  required: true
  readable: true
  writeable: true
supported operation: Retrieves WhiteListIp resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves WhiteListIp resource.
  returns: WhiteListIp
supported operation: Deletes the WhiteListIp resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the WhiteListIp resource.
  returns: Nothing

company
type: Property
domain: WhiteListIp
max cardinality: 1
range: Company

ip
type: Property
domain: WhiteListIp
range: string

Compliance
type: Class
title: Compliance
supported property: SupportedProperty
  property: ip
  title: ip
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userCompanyProfile
  title: userCompanyProfile
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updated
  title: updated
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Compliance resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Compliance resource.
  returns: Compliance

ip
type: Property
domain: Compliance
range: string

userCompanyProfile
type: Property
domain: Compliance
max cardinality: 1
range: UserCompanyProfile

created
type: Property
domain: Compliance
range: dateTime

updated
type: Property
domain: Compliance
range: dateTime

Country
type: Class
title: Country
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Country resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Country resource.
  returns: Country

code
type: Property
domain: Country
range: string

name
type: Property
domain: Country
range: string

Language
type: Class
title: Language
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isEnabled
  title: isEnabled
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: isDefault
  title: isDefault
  required: false
  readable: false
  writeable: false
supported operation: Retrieves Language resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Language resource.
  returns: Language

code
type: Property
domain: Language
range: string

language
type: Property
domain: Language
range: string

isEnabled
type: Property
domain: Language
range: boolean

isDefault
type: Property
domain: Language
range: boolean

CompanySubscription
type: Class
title: CompanySubscription
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subscriptionId
  title: subscriptionId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: application
  title: application
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported operation: Retrieves CompanySubscription resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves CompanySubscription resource.
  returns: CompanySubscription
supported operation: Deletes the CompanySubscription resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the CompanySubscription resource.
  returns: Nothing

company
type: Property
domain: CompanySubscription
max cardinality: 1
range: Company

subscriptionId
type: Property
domain: CompanySubscription
range: string

application
type: Property
domain: CompanySubscription
max cardinality: 1
range: Application

status
type: Property
domain: CompanySubscription

SignUpPage
type: Class
title: SignUpPage
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: seoName
  title: seoName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: image
  title: image
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: tagLine
  title: tagLine
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: application
  title: application
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: billing
  title: billing
  required: false
  readable: true
  writeable: false
supported operation: Retrieves SignUpPage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SignUpPage resource.
  returns: SignUpPage

title
type: Property
domain: SignUpPage
range: string

seoName
type: Property
domain: SignUpPage
range: string

image
type: Property
domain: SignUpPage
range: string

tagLine
type: Property
domain: SignUpPage
range: string

description
type: Property
domain: SignUpPage
range: string

application
type: Property
domain: SignUpPage
max cardinality: 1
range: Application

billing
type: Property
domain: SignUpPage
range: boolean

Onboarding
type: Class
title: Onboarding
supported property: SupportedProperty
  property: application
  title: application
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: failureReason
  title: failureReason
  required: false
  readable: true
  writeable: false
supported operation: Updates the Onboarding resource.
  type: Operation
  expects: Onboarding
  method: PATCH
  title: Updates the Onboarding resource.
  returns: Onboarding
supported operation: Retrieves Onboarding resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Onboarding resource.
  returns: Onboarding

application
type: Property
domain: Onboarding
max cardinality: 1
range: Application

status
type: Property
domain: Onboarding
range: string

failureReason
type: Property
domain: Onboarding
range: string

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of MediaObject resources
  title: The collection of MediaObject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ExternalUser resources
  title: The collection of ExternalUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Company resources
  title: The collection of Company resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserCompanyProfile resources
  title: The collection of UserCompanyProfile resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Dashboard resources
  title: The collection of Dashboard resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DashboardUser resources
  title: The collection of DashboardUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Team resources
  title: The collection of Team resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Role resources
  title: The collection of Role resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Application resources
  title: The collection of Application resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserDevice resources
  title: The collection of UserDevice resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Integration resources
  title: The collection of Integration resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of BambooHr resources
  title: The collection of BambooHr resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of WhiteListIp resources
  title: The collection of WhiteListIp resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Compliance resources
  title: The collection of Compliance resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Country resources
  title: The collection of Country resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Language resources
  title: The collection of Language resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CompanySubscription resources
  title: The collection of CompanySubscription resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SignUpPage resources
  title: The collection of SignUpPage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Onboarding resources
  title: The collection of Onboarding resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of MediaObject resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MediaObject
supported operation: Creates a MediaObject resource.
  type: Operation
  type: CreateAction
  expects: MediaObject
  method: POST
  title: Creates a MediaObject resource.
  returns: MediaObject

The collection of ExternalUser resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ExternalUser
supported operation: Retrieves the collection of ExternalUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ExternalUser resources.
  returns: Collection

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Retrieves the collection of UserCompanyProfile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserCompanyProfile resources.
  returns: UserCompanyProfile
supported operation: Retrieves the collection of DashboardUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DashboardUser resources.
  returns: DashboardUser
supported operation: Retrieves the collection of UserDevice resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserDevice resources.
  returns: UserDevice

The collection of Company resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Company
supported operation: Retrieves the collection of Company resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Company resources.
  returns: Collection
supported operation: Creates a Company resource.
  type: Operation
  type: CreateAction
  expects: Company
  method: POST
  title: Creates a Company resource.
  returns: Company
supported operation: Retrieves the collection of Dashboard resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Dashboard resources.
  returns: Dashboard
supported operation: Retrieves the collection of Team resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Team resources.
  returns: Team
supported operation: Retrieves the collection of WhiteListIp resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WhiteListIp resources.
  returns: WhiteListIp

The collection of UserCompanyProfile resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserCompanyProfile
supported operation: Retrieves the collection of UserCompanyProfile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserCompanyProfile resources.
  returns: Collection
supported operation: Creates a UserCompanyProfile resource.
  type: Operation
  type: CreateAction
  expects: UserCompanyProfile
  method: POST
  title: Creates a UserCompanyProfile resource.
  returns: UserCompanyProfile

The collection of Dashboard resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Dashboard
supported operation: Retrieves the collection of Dashboard resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Dashboard resources.
  returns: Collection
supported operation: Creates a Dashboard resource.
  type: Operation
  type: CreateAction
  expects: Dashboard
  method: POST
  title: Creates a Dashboard resource.
  returns: Dashboard
supported operation: Retrieves the collection of DashboardUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DashboardUser resources.
  returns: DashboardUser

The collection of DashboardUser resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DashboardUser
supported operation: Creates a DashboardUser resource.
  type: Operation
  type: CreateAction
  expects: DashboardUser
  method: POST
  title: Creates a DashboardUser resource.
  returns: DashboardUser

The collection of Team resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Team
supported operation: Creates a Team resource.
  type: Operation
  type: CreateAction
  expects: Team
  method: POST
  title: Creates a Team resource.
  returns: Team
supported operation: Retrieves the collection of UserCompanyProfile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserCompanyProfile resources.
  returns: UserCompanyProfile

The collection of Role resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Role
supported operation: Retrieves the collection of Role resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Role resources.
  returns: Collection

The collection of Application resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Application
supported operation: Retrieves the collection of Application resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Application resources.
  returns: Collection
supported operation: Retrieves the collection of UserDevice resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserDevice resources.
  returns: UserDevice

The collection of UserDevice resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserDevice
supported operation: Creates a UserDevice resource.
  type: Operation
  type: CreateAction
  expects: UserDevice
  method: POST
  title: Creates a UserDevice resource.
  returns: UserDevice
supported operation: Retrieves the collection of UserDevice resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserDevice resources.
  returns: Collection

The collection of Integration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Integration
supported operation: Retrieves the collection of Integration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Integration resources.
  returns: Collection
supported operation: Creates a Integration resource.
  type: Operation
  type: CreateAction
  expects: Integration
  method: POST
  title: Creates a Integration resource.
  returns: Integration

The collection of BambooHr resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BambooHr
supported operation: Retrieves the collection of BambooHr resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of BambooHr resources.
  returns: Collection
supported operation: Creates a BambooHr resource.
  type: Operation
  type: CreateAction
  expects: BambooHr
  method: POST
  title: Creates a BambooHr resource.
  returns: BambooHr

The collection of WhiteListIp resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WhiteListIp
supported operation: Creates a WhiteListIp resource.
  type: Operation
  type: CreateAction
  expects: WhiteListIp
  method: POST
  title: Creates a WhiteListIp resource.
  returns: WhiteListIp

The collection of Compliance resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Compliance
supported operation: Retrieves the collection of Compliance resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Compliance resources.
  returns: Collection
supported operation: Creates a Compliance resource.
  type: Operation
  type: CreateAction
  expects: Compliance
  method: POST
  title: Creates a Compliance resource.
  returns: Compliance

The collection of Country resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Country
supported operation: Retrieves the collection of Country resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Country resources.
  returns: Collection

The collection of Language resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Language
supported operation: Retrieves the collection of Language resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Language resources.
  returns: Collection

The collection of CompanySubscription resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CompanySubscription
supported operation: Retrieves the collection of CompanySubscription resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CompanySubscription resources.
  returns: Collection
supported operation: Creates a CompanySubscription resource.
  type: Operation
  type: CreateAction
  expects: CompanySubscription
  method: POST
  title: Creates a CompanySubscription resource.
  returns: CompanySubscription

The collection of SignUpPage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SignUpPage
supported operation: Retrieves the collection of SignUpPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SignUpPage resources.
  returns: Collection

The collection of Onboarding resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Onboarding
supported operation: Retrieves the collection of Onboarding resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Onboarding resources.
  returns: Collection
supported operation: Retrieves the collection of Onboarding resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Onboarding resources.
  returns: Collection

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation