Company Basic Settings

Attributes

Name	Type	Description
name	string
default_interview_period	integer
timezone	string
default_maximum_score	integer
identifier	string	represented as the subdomain
website	string	optional
registration_email	string	optional
default_project_lang	string	See languages for available language codes, which differ by company.
partner_data	object	optional
share_candidate_enabled	boolean	whether share candidates feature is active
team_evaluation_enabled	boolean	whether team evaluation feature is active
DOC_required	boolean	wheter candidates for this company need to agree to a Declaration of Consent to proceed with their interview
veto_enabled	boolean	whether veto candidate feature is active
open_project_reminder_period	integer	how many days after activating a project, should project administrators receive alert notifications to close the project? (0 means never)
open_project_reminder_frequency	integer	how often should project admins receive alert notifications to close the project via email? (0 - never, 1 - daily, 7 - weekly, 30 - monthly)
saml_status	boolean	read only; whether SAML SSO is enabled for the company
restrict_user_add	boolean	read only; whether users can add other users in the GUI (affected by SAML settings)
restrict_user_delete	boolean	read only; whether users can delete other users in GUI (affected by SAML settings)
restrict_change_account_type	boolean	read only; whether users can change other users’ account types in the GUI (affected by SAML settings)

Object

/companies/{{companyId}}/settings/

Methods

• GET
• PATCH

Example response

{"name":"viasto",
 "belongs_to":null,
 "domain":"daedalus.viasto.com",
 "timezone":"Europe/Berlin",
 "default_interview_period":7,
 "default_maximum_score":5,
 "partner_data":{},
 "default_project_lang":"",
 "website":"",
 "identifier":"viasto",
 "registration_email":"noreply@viasto.daedalus.viasto.com",
 "share_candidate_enabled": true,
 "team_evaluation_enabled": true,
 "DOC_required": false,
 "saml_status": false,
 "restrict_user_add": false,
 "restrict_user_delete": false,
 "restrict_change_account_type": false
 }