| identifier |
uuid |
required company unique identifier |
| name |
string |
required |
| slug |
string |
|
| mainLogoUrl |
uri |
|
| mainWebsiteUrl |
uri |
|
| privacyPolicyUrl |
uri |
|
| termsOfServiceUrl |
uri |
|
| defaultBrandUuid |
uuid |
|
| address |
object |
address object |
| hasSetupPortal |
boolean |
whether the portal has been configured at least once |
| metadata |
object |
Optional metadata object containing self-serve account information and other additional fields. |
| legalName |
string |
|
| ein |
string |
Employer identification number |
| hireAccountUuid |
string |
Account UUID in Fountain Hire |
| hireAccountBaseUrl |
string |
Account base URL in Fountain Hire |
| hireGoAccountBaseUrl |
string |
Account base URL for Fountain Go |
| careerSiteUrl |
string |
Account Career Site base URL in Fountain Hire |
| hireAccountApiKey |
string |
Account API key in Fountain Hire |
| hireAccountRecruiterBaseUrl |
string |
Account Recruiter Base URL in Fountain Hire |
| hireAccountSlug |
string |
Account slug in Fountain Hire |
| supportEmail |
string |
Contact email for workers needing additional assistance |
| supportPhone |
string |
Contact phone number for workers needing additional assistance |
| supportUrl |
string |
Customer-facing support URL |
| contactEmail |
string |
Email of the authorized representative for SMS brand registration |
| contactPhone |
string |
Phone number of the authorized representative for SMS brand registration |
| alternativeSupportPhones |
array of objects |
Alternative phone numbers for workers according to their hiring source |
| hireMessagingEnabled |
boolean |
Enables or disables employer messaging functionality for Hire applicants |
| workdayMessagingEnabled |
boolean |
Enables or disables employer messaging functionality for Workday candidates |
| enableHireDataSync |
boolean |
Enables or disables automated data synchronization with Fountain Hire |
| hasHireGoAccount |
boolean |
This company has a Fountain Hire Go account |
| unifiedAuth |
boolean |
This company uses unified authentication system |
| unifiedAccess |
boolean |
This company uses unified access system |
| tfaRequired |
boolean |
If true, all users in this company need 2fa enabled |
| inactivityLockDays |
integer |
90 to 365. Number of days before a worker is considered inactive and locked out of the system |
| passwordPolicy |
object |
Password policy for employers in the company |
| portalOptions |
object |
Portal options object |
| companyType |
string |
enum. Defaults to internal. Allowed: active, internal, pilot, demo |
| accountStatus |
string |
enum. Defaults to live. Allowed: live, paused, churned |
| contactFirstName |
string |
Contact first name for SMS brand registration |
| contactLastName |
string |
Contact last name for SMS brand registration |
| vertical |
string |
Industry vertical for SMS brand registration |
| salesforceId |
string |
Salesforce ID for the company |
| selfServe |
boolean |
Defaults to false. Indicates if this company was created through self-serve registration |
| companyContext |
string |
Free-form context notes about the company. |
| timezone |
string |
enum. IANA timezone identifier for the company. |