--- title: "Get referral setting by company UUID (public)" method: GET path: "/api/servicereferral/processes/referralSettings/{companyUuid}" tags: ["referralSettings"] --- # Get referral setting by company UUID (public) `GET /api/servicereferral/processes/referralSettings/{companyUuid}` ## Request - Base URL: `https://services.fountain.com` - URL: `https://services.fountain.com/api/servicereferral/processes/referralSettings/{companyUuid}` - Auth: none required Returns referral setting for a company, public endpoint for referral workers ## Path parameters - `companyUuid` string, uuid, required ## Response `200` Referral setting found - object - `data` ReferralSetting, required - `uuid` string, uuid - `createdAt` string, date-time - `createdBy` string, uuid - `lastUpdatedAt` string, date-time - `lastUpdatedBy` string, uuid - `lastUpdatedByAudience` string - `lastUpdatedByAudienceUuid` string, uuid - `lastUpdatedByImpersonatedBy` string, uuid - `lastUpdatedByCompanyUuid` string, uuid - `lastUpdatedByEnterpriseUuid` string, uuid - `companyUuid` string, uuid - `enabled` boolean - `strictLinks` boolean - `isBrandSpecific` boolean - `virtualCompany` object - `uuid` string, uuid - `createdAt` string, date-time - `createdBy` string, uuid - `lastUpdatedAt` string, date-time - `lastUpdatedBy` string, uuid - `lastUpdatedByAudience` string - `lastUpdatedByAudienceUuid` string, uuid - `lastUpdatedByImpersonatedBy` string, uuid - `lastUpdatedByCompanyUuid` string, uuid - `lastUpdatedByEnterpriseUuid` string, uuid - `name` string, required - `slug` string - `mainLogoUrl` string, uri - `mainWebsiteUrl` string, uri, nullable - `privacyPolicyUrl` string, uri - `defaultBrandUuid` string, uuid - `address` object - `address1` string - `address2` string - `city` string - `zip` string - `state` string - `country` string - `hasSetupPortal` boolean: whether the portal has been configured at least once - `workerPortalFullWindow` boolean: whether the worker portal shows Onboard pages in the full window instead of the mobile device frame - `metadata` object: Optional metadata object containing self-serve account information and other additional fields. - `inferredProducts` string[]: Inferred products for the company - `outcomes` string[]: Desired outcomes - `hiresPerYear` string: Estimated number of hires per year - `customIndustry` string: Custom industry if not in standard list - `industry` string: Industry type - `country` string: ISO 3166-1 alpha-2 country code - `legalName` string - `ein` string: Employer identification number - `hireConnectedAt` string, date-time, nullable: when the hire account was connected - `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 - `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` object[]: Alternative phone numbers for workers according to their hiring source - `number` string, required - `source` string, required - `hireMessagingEnabled` boolean: Enables or disables employer messaging functionality for Hire applicants - `workdayMessagingEnabled` boolean: Enables or disables employer messaging functionality for Workday candidates - `messagingDisabled` boolean: Company-level messaging kill switch set by the churn tool; when true, no worker messages are sent regardless of per-worker messagingEnabled - `churnedAt` string, date-time, nullable: when the company was churned by the super-user churn tool; absent means not churned - `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 - `fountainOneWorkerCreationEnabled` boolean: Hire creates the workers of this company natively (new Fountain One account); mirrored from Hire - `tfaRequired` boolean: If true, all users in this company need 2fa enabled - `inactivityLockDays` integer: Number of days before a worker is considered inactive and locked out of the system - `passwordPolicy` object: Password policy for employers in the company - `minLength` integer: Minimum length of the password - `expireAfterDays` integer: Number of days before the password expires - `portalOptions` object - `enableMagicLink` boolean - `enableOtp` boolean - `enableUpdateContactInfo` object - `firstname` boolean - `lastname` boolean - `personalEmail` boolean - `mobilePhone` boolean - `enableSmsOptOut` boolean - `enableMultiProfileLogin` boolean - `companyType` 'active' | 'internal' | 'pilot' | 'demo' - `accountStatus` 'live' | 'paused' | 'churned': Lifecycle status mirrored from the Hire account. Only settable via the internal process endpoint. - `paymentOverdueWarning` boolean: Hire flags the account with an overdue balance; administrators see a warning. Only settable via the internal process endpoint. - `contactFirstName` string: Contact first name for SMS brand registration - `contactLastName` string: Contact last name for SMS brand registration - `vertical` 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION': Industry vertical for SMS brand registration - `salesforceId` string: Salesforce ID for the company - `selfServe` boolean: Indicates if this company was created through self-serve registration - `companyContext` string: Free-form context notes about the company. - `timezone` 'Pacific/Niue' | 'Pacific/Pago_Pago' | 'Pacific/Honolulu' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Marquesas' | 'America/Anchorage' | 'Pacific/Gambier' | 'America/Los_Angeles' | 'America/Tijuana' | 'America/Vancouver' | 'America/Whitehorse' | 'Pacific/Pitcairn' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Edmonton' | 'America/Hermosillo' | 'America/Mazatlan' | 'America/Phoenix' | 'America/Yellowknife' | 'America/Belize' | 'America/Chicago' | 'America/Costa_Rica' | 'America/El_Salvador' | 'America/Guatemala' | 'America/Managua' | 'America/Mexico_City' | 'America/Regina' | 'America/Tegucigalpa' | 'America/Winnipeg' | 'Pacific/Galapagos' | 'America/Bogota' | 'America/Cancun' | 'America/Cayman' | 'America/Guayaquil' | 'America/Havana' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Lima' | 'America/Nassau' | 'America/New_York' | 'America/Panama' | 'America/Port-au-Prince' | 'America/Rio_Branco' | 'America/Toronto' | 'Pacific/Easter' | 'America/Caracas' | 'America/Asuncion' | 'America/Barbados' | 'America/Boa_Vista' | 'America/Campo_Grande' | 'America/Cuiaba' | 'America/Curacao' | 'America/Grand_Turk' | 'America/Guyana' | 'America/Halifax' | 'America/La_Paz' | 'America/Manaus' | 'America/Martinique' | 'America/Port_of_Spain' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Santo_Domingo' | 'America/Thule' | 'Atlantic/Bermuda' | 'America/St_Johns' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Bahia' | 'America/Belem' | 'America/Cayenne' | 'America/Fortaleza' | 'America/Godthab' | 'America/Maceio' | 'America/Miquelon' | 'America/Montevideo' | 'America/Paramaribo' | 'America/Recife' | 'America/Santiago' | 'America/Sao_Paulo' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Atlantic/Stanley' | 'America/Noronha' | 'Atlantic/South_Georgia' | 'America/Scoresbysund' | 'Atlantic/Azores' | 'Atlantic/Cape_Verde' | 'Africa/Abidjan' | 'Africa/Accra' | 'Africa/Bissau' | 'Africa/Casablanca' | 'Africa/El_Aaiun' | 'Africa/Monrovia' | 'America/Danmarkshavn' | 'Atlantic/Canary' | 'Atlantic/Faroe' | 'Atlantic/Reykjavik' | 'Etc/GMT' | 'Europe/Dublin' | 'Europe/Lisbon' | 'Europe/London' | 'Africa/Algiers' | 'Africa/Ceuta' | 'Africa/Lagos' | 'Africa/Ndjamena' | 'Africa/Tunis' | 'Africa/Windhoek' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Budapest' | 'Europe/Copenhagen' | 'Europe/Gibraltar' | 'Europe/Ljubljana' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Monaco' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Rome' | 'Europe/Stockholm' | 'Europe/Tirane' | 'Europe/Vienna' | 'Europe/Warsaw' | 'Europe/Zurich' | 'Africa/Cairo' | 'Africa/Johannesburg' | 'Africa/Maputo' | 'Africa/Tripoli' | 'Asia/Amman' | 'Asia/Beirut' | 'Asia/Damascus' | 'Asia/Gaza' | 'Asia/Jerusalem' | 'Asia/Nicosia' | 'Europe/Athens' | 'Europe/Bucharest' | 'Europe/Chisinau' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kyiv' | 'Europe/Riga' | 'Europe/Sofia' | 'Europe/Tallinn' | 'Europe/Vilnius' | 'Africa/Khartoum' | 'Africa/Nairobi' | 'Antarctica/Syowa' | 'Asia/Baghdad' | 'Asia/Qatar' | 'Asia/Riyadh' | 'Europe/Minsk' | 'Europe/Moscow' | 'Asia/Tehran' | 'Asia/Baku' | 'Asia/Dubai' | 'Asia/Tbilisi' | 'Asia/Yerevan' | 'Europe/Samara' | 'Indian/Mahe' | 'Indian/Mauritius' | 'Indian/Reunion' | 'Asia/Kabul' | 'Antarctica/Mawson' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Dushanbe' | 'Asia/Karachi' | 'Asia/Tashkent' | 'Asia/Yekaterinburg' | 'Indian/Kerguelen' | 'Indian/Maldives' | 'Asia/Calcutta' | 'Asia/Colombo' | 'Asia/Katmandu' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Bishkek' | 'Asia/Dhaka' | 'Asia/Omsk' | 'Asia/Thimphu' | 'Indian/Chagos' | 'Asia/Rangoon' | 'Indian/Cocos' | 'Antarctica/Davis' | 'Asia/Bangkok' | 'Asia/Hovd' | 'Asia/Jakarta' | 'Asia/Krasnoyarsk' | 'Asia/Saigon' | 'Asia/Ho_Chi_Minh' | 'Indian/Christmas' | 'Antarctica/Casey' | 'Asia/Brunei' | 'Asia/Choibalsan' | 'Asia/Hong_Kong' | 'Asia/Irkutsk' | 'Asia/Kuala_Lumpur' | 'Asia/Macau' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Taipei' | 'Asia/Ulaanbaatar' | 'Australia/Perth' | 'Asia/Pyongyang' | 'Asia/Dili' | 'Asia/Jayapura' | 'Asia/Seoul' | 'Asia/Tokyo' | 'Asia/Yakutsk' | 'Pacific/Palau' | 'Australia/Adelaide' | 'Australia/Darwin' | 'Antarctica/DumontDUrville' | 'Asia/Magadan' | 'Asia/Vladivostok' | 'Australia/Brisbane' | 'Asia/Sakhalin' | 'Australia/Hobart' | 'Australia/Sydney' | 'Pacific/Chuuk' | 'Pacific/Guam' | 'Pacific/Port_Moresby' | 'Pacific/Efate' | 'Pacific/Guadalcanal' | 'Pacific/Kosrae' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pohnpei' | 'Asia/Kamchatka' | 'Pacific/Auckland' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Nauru' | 'Pacific/Tarawa' | 'Pacific/Wake' | 'Pacific/Wallis' | 'Pacific/Apia' | 'Pacific/Enderbury' | 'Pacific/Fakaofo' | 'Pacific/Tongatapu' | 'Pacific/Kiritimati' | 'UTC': IANA timezone identifier for the company (e.g. "America/Chicago"). Used to determine business hours for outbound worker actions. - `freemiumProducts` object: Per-product freemium access flags (internal only) - `pool` object - `enabled` boolean: Whether Pool freemium is enabled for this company - `workerExperience` object - `header` string, required - `termsAndConditions` string - `applicantExperience` object - `content` string, required - `relationQuestion` object, required - `title` string, required - `enabled` boolean, required - `retentionMetric` object - `numberOfDays` number, required - `payoutCondition` 'daysAfterStart' | 'daysAfterHire' | 'shiftsCompleted', required - `workerEligibility` object: Which workers may use Referrals in the worker portal. Absent means every worker. Never returned to a worker. - `mode` 'all' | 'segments', required - `segmentUuids` string[], required: Segments whose members may use Referrals. Empty when mode is 'all'. - `workerEligible` boolean: Whether the calling worker may use Referrals. Present only on a worker read of GET /processes/referralSettings/:companyUuid while worker eligibility is enforced for the company. Absent means eligible. - `meta` ResponsesPartMeta, required - `timestamp` string, date-time, required - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' - `path` string - `jti` string - `rid` string - `count` number - `capped` boolean: The server lowered filter[limit] to its ceiling. Page with filter[skip] to read past it. - `status` string - `duration` number - `size` number ## Other responses - `404`: Referral setting not found - `500`: default error response --- [API](https://skmtc.dev/fountain/apis/worker-experience-public-api.md) - [All operations](https://skmtc.dev/fountain/apis/worker-experience-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fountain/apis/worker-experience-public-api/revisions/6b9a31f79e22?raw)