--- title: "find many w4Profiles" method: GET path: "/api/servicetodo/w4Profiles" tags: ["w4Profiles"] --- # find many w4Profiles `GET /api/servicetodo/w4Profiles` Find many w4Profiles (with filtering, projection, pagination and limiting). You can use filters in the query parameters (properly URL encoded) to restrict the search results: - To restrict the search to specific values for a given field name, you can use the following syntax: filter[where][fieldName][eq]=value. Note that you can also nest the filter object to filter on multiple fields, like so: filter[where][and][0][fieldName1][eq]=value1&filter[where][and][1][fieldName2][eq]=value2. You can also use operators like gt, gte, lt, lte, ne, in, nin, etc. - To limit the number of results returned by the query, use the following syntax: filter[limit]=25&filter[skip]=25 - To only return specific fields, use the projection query parameter. Usage is as follows: filter[fields][fieldName1]=true&filter[fields][fieldName2]=true. ## Query parameters - `filter` ParametersFilter - `where` ParametersFilterWhere - `fields` ParametersFilterFields - `limit` number - `skip` number - `order` string[] - `collate` ParametersFilterCollation - `locale` string - `strength` number - `caseLevel` boolean - `numericOrdering` boolean ## Response `200` One or many w4Profile documents found. Wrapped in a JsonAPI root response with collection of documents as data. - object - `data` W4Profile[] - `uuid` string, uuid, required - `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, required - `company` 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 - `privacyPolicyUrl` string, uri - `termsOfServiceUrl` 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 - `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 - `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` 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 - `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 — 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 - `companyType` 'active' | 'internal' | 'pilot' | 'demo' - `accountStatus` 'live' | 'paused' | 'churned' — Lifecycle status mirrored from the Hire account. 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` string — 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 - `workerUuid` string, uuid, required - `employerUuid` string, uuid - `resourceType` 'worker' | 'employer' - `employer` 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 - `companyUuid` string, uuid, required - `company` object - `uuid` string, uuid - `slug` string - `firstname` string - `lastname` string - `position` string - `displayFullName` string - `email` string, email, required - `notificationEmail` string, email - `firstSeenAt` string, date-time - `lastSeenAt` string, date-time - `timezone` string - `locale` string - `avatar` string, uri - `invitedByUser` string, uuid - `unitaryLocationUuids` string[] - `unitaryLocations` object[] - `uuid` string, uuid — Unique identifier - `createdAt` string, date-time — Creation timestamp - `createdBy` string, uuid — Creator UUID - `lastUpdatedAt` string, date-time — Last update timestamp - `lastUpdatedBy` string, uuid — Last updater UUID - `lastUpdatedByAudience` string — Audience of last updater - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater - `name` string, required - `description` string - `companyUuid` string, uuid - `street_address` string - `address_2` string - `city` string - `state_code` string - `postal_code` string - `country_code` 'US' | 'AD' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'AE' | 'UM' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — 2-letter ISO country code - `locationNotes` string - `timezone` string - `language` string - `externalLocation` object — Metadata storage of the location data from an external source - `source` 'hire' | 'hire-go' | 'workday', required - `externalIdentifier` string, required - `externalCreatedAt` string, date-time, required - `geolocation` object - `latitude` number, required - `longitude` number, required - `brandUuid` string, uuid, nullable - `isRemote` boolean - `ownerUuid` string, uuid, nullable - `locationGroupUuid` string, uuid, nullable - `virtualLocationGroup` object - `name` string - `locationGroupUuids` string[] - `locationGroups` object[] - `uuid` string, uuid - `createdAt` string, date-time — Creation timestamp - `createdBy` string, uuid — Creator UUID - `lastUpdatedAt` string, date-time — Last update timestamp - `lastUpdatedBy` string, uuid — Last updater UUID - `lastUpdatedByAudience` string — Audience of last updater - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater - `name` string, required — Location group name - `description` string - `companyUuid` string, uuid — Company UUID - `ownerUuid` string - `hireLocationGroupUuid` string - `parentGroupUuid` string - `locationUuids` string[] - `locations` object[] - `uuid` string, uuid — Unique identifier - `createdAt` string, date-time — Creation timestamp - `createdBy` string, uuid — Creator UUID - `lastUpdatedAt` string, date-time — Last update timestamp - `lastUpdatedBy` string, uuid — Last updater UUID - `lastUpdatedByAudience` string — Audience of last updater - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater - `name` string, required - `description` string - `companyUuid` string, uuid - `street_address` string - `address_2` string - `city` string - `state_code` string - `postal_code` string - `country_code` 'US' | 'AD' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'AE' | 'UM' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — 2-letter ISO country code - `locationNotes` string - `timezone` string - `language` string - `externalLocation` object — Metadata storage of the location data from an external source - `source` 'hire' | 'hire-go' | 'workday', required - `externalIdentifier` string, required - `externalCreatedAt` string, date-time, required - `geolocation` object - `latitude` number, required - `longitude` number, required - `brandUuid` string, uuid, nullable - `isRemote` boolean - `ownerUuid` string, uuid, nullable - `locationGroupUuid` string, uuid, nullable - `virtualLocationGroup` object - `name` string - `externalEmployer` object — Metadata storage of the employer data from an external source - `source` string, required - `externalIdentifier` string, uuid - `externalEmployeeId` string - `provisioningSource` 'scim' | 'jit' - `scimUserName` string - `hideFromLogNotes` boolean - `anonymizeInLogNotes` boolean - `active` boolean — if false, user will not be able to log in - `invitationMessageEnabled` boolean — if false, user will not receive the initial welcome message when they first enter the WX system - `hasJobRestriction` boolean — If true, the employer has job restrictions (access is limited to jobs in the audienceJobs table). If false (default), the employer can access all jobs. Only applies when company.unifiedAccess = true - `scimRestrictionOverrides` object — Per-dimension SCIM wildcard flags (true = IdP granted all access for that dimension). Set by SCIM provisioning. - `locations` boolean - `jobs` boolean - `openings` boolean - `restrictionOverrides` object — Unified per-dimension access overrides. all=true means wildcard access for that dimension. source indicates the managing system. - `locations` object - `all` boolean, required - `source` 'scim' | 'sso' | 'direct', required - `jobs` object - `all` boolean, required - `source` 'scim' | 'sso' | 'direct', required - `openings` object - `all` boolean, required - `source` 'scim' | 'sso' | 'direct', required - `employerActivated` boolean — Is employee flagged as employer on third party I9 provider - `worker` object - `uuid` string, uuid — Unique identifier - `createdAt` string, date-time — Creation timestamp - `createdBy` string, uuid — Creator UUID - `lastUpdatedAt` string, date-time — Last update timestamp - `lastUpdatedBy` string, uuid — Last updater UUID - `lastUpdatedByAudience` string — Audience of last updater - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater - `firstname` string, required - `lastname` string - `middlename` string - `hasNoMiddleName` boolean - `displayFullName` string - `dashboardUrl` object - `slug` string, required - `baseUrl` string - `personalEmail` object, required - `email` string, email, required - `verified` boolean - `verifiedAt` string, date-time - `workEmail` object - `email` string, email - `verified` boolean - `verifiedAt` string, date-time - `mobilePhone` object - `number` string - `countryCode` string - `verified` boolean - `verifiedAt` string, date-time - `whatsAppPhone` object - `number` string - `countryCode` string - `verified` boolean - `verifiedAt` string, date-time - `homePhone` object - `number` string - `countryCode` string - `verified` boolean - `verifiedAt` string, date-time - `homeAddress` object - `address1` string - `address2` string - `city` string - `zip` string - `state` string - `country` string - `timezone` string - `locale` string, nullable - `companyUuid` string, uuid, required - `company` object - `uuid` string, uuid - `name` string - `slug` string - `jobUuid` string, uuid, nullable - `job` object - `uuid` string, uuid - `name` string - `description` string - `jobIdentifiers` object[] - `jobUuid` string, uuid - `relationship` 'primary' | 'secondary' - `jobs` object[] - `uuid` string, uuid - `name` string - `description` string - `allowUnscheduledShift` boolean - `brandUuid` string, uuid, nullable - `brand` object - `uuid` string, uuid - `name` string - `einUuid` string, uuid, nullable - `ein` object - `uuid` string, uuid - `label` string - `locationUuid` string, uuid - `locationUuids` string[] - `locationGroupUuids` string[] - `locations` object[] - `uuid` string, uuid — Unique identifier - `createdAt` string, date-time — Creation timestamp - `createdBy` string, uuid — Creator UUID - `lastUpdatedAt` string, date-time — Last update timestamp - `lastUpdatedBy` string, uuid — Last updater UUID - `lastUpdatedByAudience` string — Audience of last updater - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater - `name` string, required - `description` string - `companyUuid` string, uuid - `street_address` string - `address_2` string - `city` string - `state_code` string - `postal_code` string - `country_code` 'US' | 'AD' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'AE' | 'UM' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — 2-letter ISO country code - `locationNotes` string - `timezone` string - `language` string - `externalLocation` object — Metadata storage of the location data from an external source - `source` 'hire' | 'hire-go' | 'workday', required - `externalIdentifier` string, required - `externalCreatedAt` string, date-time, required - `geolocation` object - `latitude` number, required - `longitude` number, required - `brandUuid` string, uuid, nullable - `isRemote` boolean - `ownerUuid` string, uuid, nullable - `locationGroupUuid` string, uuid, nullable - `virtualLocationGroup` object - `name` string - `tags` object[] - `uuid` string, uuid - `name` string - `people` object - `uuid` string, required — reference UUID of the people entity - `index` number, required — index of the number of profile for one people entity - `locked` boolean, required — whether the people entity is locked - `reasons` string[] - `rehire` object - `isRehire` boolean — whether the worker is a rehire - `uuid` string — UUID of the previous worker profile. Absent when there is no matching duplicate. - `reasons` string[] — Why the rehire flag was set. Mirrors people.reasons for deduplication context. - `externalId` string — reference ID in external HRIS - `externalSource` string — source of truth for worker externalId - `externalSourceAccount` string — account of the external source - `applicantId` string — reference ID in ATS - `applicantSource` string — source of truth for worker applicantId - `backgroundCheckYardstikCandidateId` string — reference ID in 3rd party background check system - `dateOfBirth` string, date - `startDate` string, date - `hireDate` string, date - `terminationDate` string, date - `firstSeenAt` string, date-time - `lastSeenAt` string, date-time - `employmentStatus` object - `type` 'created' | 'preHire' | 'active' | 'rehire' | 'inactive' | 'terminated' | 'temporary' - `subtype` 'applicant' | 'employee' | 'leaveOfAbsence' | 'suspended' | 'seasonal' | 'furloughed' | 'resigned' | 'fired' | 'involuntarySeparation' | 'archived' - `lastStatusUpdateDate` string, date-time - `avatar` string, uri - `manager` object - `uuid` string, uuid - `displayFullName` string - `customAttributes` object[] - `customAttributeUuid` string, uuid - `value` union, required - string - string[] - object - `uuid` string, uuid - `url` string - `metadata` object - object - `address` string - `address2` string - `city` string - `state` string - `zip` string - `country` string - boolean - unknown - `translatedValue` string - `selectedLabels` string[] - `invalid` boolean - `invalidDetail` string - `customAttribute` object - `uuid` string, uuid - `createdAt` string, date-time — Creation timestamp - `createdBy` string, uuid — Creator UUID - `lastUpdatedAt` string, date-time — Last update timestamp - `lastUpdatedBy` string, uuid — Last updater UUID - `lastUpdatedByAudience` string — Audience of last updater - `lastUpdatedByAudienceUuid` string, uuid — Audience UUID of last updater - `lastUpdatedByImpersonatedBy` string, uuid — Impersonator UUID - `lastUpdatedByCompanyUuid` string, uuid — Company UUID of last updater - `lastUpdatedByEnterpriseUuid` string, uuid — Enterprise UUID of last updater - `companyUuid` string, uuid — Company UUID - `label` string, required - `key` string - `dataType` 'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument', required - `description` string - `options` object[] - `value` string, required - `label` string - `hireValue` unknown - `resource` string - `resourceIdentifier` string, uuid - `readOnly` boolean — If true, this attribute cannot be modified. Can only be set by system. - `hidden` boolean — If true, this attribute won't be shown. Can only be set by system. - `protected` boolean — If true, this attribute can only be accessed by users with certain rights. - `hireDataKeyId` integer — The ID of the hire data key - `calculatedCustomAttributes` object - `segmentEnabled` boolean — if false, worker will not be in segment without the "include deactivated workers" option - `segmentUuids` string[] — list of the different segments the worker is matching - `messagingEnabled` boolean — if false, worker will not receive any message, except if the message has the "forceSend" option - `ssoEnabled` boolean — whether or not to enable Worker Portal SSO on this particular worker - `isTestWorker` boolean — declarative setting to help differenciate test workers from real workers - `importUpdatesLocked` boolean — if true, imported workers from our partners will update existing worker records with new data - `importProvider` 'none' | 'hire' - `technicalOptions` object - `lockEin` boolean — if true, do not allow to update the worker's EIN - `ssn` string - `appliedForSsn` boolean - `securityGroupUuids` string[] - `payRate` object - `uuid` string, uuid - `rate` number - `overtimeRate` number - `externalId` string - `currency` 'USD' | 'GBP' | 'EUR' - `createdAt` string, date-time - `payRateExceptions` object[] - `uuid` string, uuid - `rate` number - `overtimeRate` number - `currency` 'USD' | 'GBP' | 'EUR' - `locationUuid` string, uuid - `jobUuid` string, uuid - `externalId` string - `createdAt` string, date-time - `supervisorUuid` string, uuid, nullable — Employer acting as supervisor for this worker - `openingOwnerUuid` string, uuid, nullable — Employer acting as opening owner for this worker - `openingUuid` string, uuid — Opening UUID assigned to this worker - `hasBackendRole` boolean - `bank` object — Bank account details - `accountNumber` string — Bank account number - `name` string — Account holder’s name - `routingNumber` string — Bank routing number - `iban` string — International Bank Account Number - `nationalIdentificationNumber` string — National identification number - `nationalTaxIdentificationNumber` string — National tax identification number - `pronouns` string — Preferred pronouns - `gender` 'MALE' | 'FEMALE' | 'NON_BINARY' | 'OTHER' | 'DECLINE_TO_SELF_IDENTIFY' - `ethnicity` 'AMERICAN_INDIAN_OR_ALASKA_NATIVE' | 'ASIAN_OR_INDIAN_SUBCONTINENT' | 'BLACK_OR_AFRICAN_AMERICAN' | 'HISPANIC_OR_LATINO' | 'NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER' | 'TWO_OR_MORE_RACES' | 'WHITE' | 'PREFER_NOT_TO_DISCLOSE' - `maritalStatus` 'SINGLE' | 'MARRIED_FILING_JOINTLY' | 'MARRIED_FILING_SEPARATELY' | 'HEAD_OF_HOUSEHOLD' | 'QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD' - `veteranStatus` 'I_AM_NOT_A_PROTECTED_VETERAN' | 'I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN' | 'I_DONT_WISH_TO_ANSWER' - `disability` 'YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY' | 'NO_I_DONT_HAVE_A_DISABILITY' | 'I_DONT_WISH_TO_ANSWER' - `underrepresentedGroupStatus` 'MEMBER_OF_UNDERREPRESENTED_GROUP' | 'NOT_A_MEMBER' | 'PREFER_NOT_TO_DISCLOSE' - `education` 'HIGH_SCHOOL_DIPLOMA_OR_EQUIVALENT' | 'SOME_COLLEGE' | 'ASSOCIATES_DEGREE' | 'BACHELORS_DEGREE' | 'MASTERS_DEGREE' | 'DOCTORAL_DEGREE' | 'PROFESSIONAL_DEGREE' - `driverLicenseNumber` string - `driverLicenseState` string - `driverLicenseExpirationDate` string - `forceRecordSessionReplayUntil` string, date-time - `talentUuid` string, uuid - `smsOptOut` object — SMS opt-out settings for the worker - `optedOutAt` string, date-time, nullable — ISO datetime (UTC) when the worker opted out - `status` boolean — Current opt-out status - `optedOutByAudience` 'worker' | 'employer' | 'enterpriseIdentity' | 'superUser' | 'system' | 'thirdParty' | 'kiosk' — Who initiated the opt-out - `optedOutByAudienceUuid` string, uuid — UUID of the entity that initiated the opt-out - `optedOutOverrideByAudienceUuid` string, nullable — UUID of the audience who overrode the opt-out - `optedOutOverrideAt` string, date-time, nullable — ISO datetime (UTC) when the opt-out was overridden - `whatsAppOptOut` object — WhatsApp opt-out settings for the worker - `optedOutAt` string, date-time, nullable — ISO datetime (UTC) when the worker opted out - `status` boolean — Current WhatsApp opt-out status - `optedOutByAudience` 'worker' | 'employer' | 'enterpriseIdentity' | 'superUser' | 'system' | 'thirdParty' | 'kiosk' — Who initiated the opt-out - `optedOutByAudienceUuid` string, uuid — UUID of the entity that initiated the opt-out - `optedOutOverrideByAudienceUuid` string, nullable — UUID of the audience who overrode the opt-out - `optedOutOverrideAt` string, date-time, nullable — ISO datetime (UTC) when the opt-out was overridden - `opening` object - `uuid` string, uuid - `title` string - `peopleUuid` string, uuid — people identifier - `workerUuids` string[] — Array of worker UUIDs - `w4Provider` 'none' | 'workbright' - `information` object - `email` string, required — employee email address - `firstName` string, required — employee first name - `lastName` string, required — employee last name - `middleName` string — employee middle name - `middleNameOptional` boolean — if the employee must fill his middle name or not - `birthdate` string — employee birth date - `phone` string — employee phone number - `gender` string — employee gender (M/F) - `nickname` string — employee nickname - `ssn` string — employee social security number - `startDate` string, required — start of employment period - `endDate` string — end of employment period - `hireDate` string — date of hiring - `address` object - `street` string — employee address street - `apt` string — employee address apartment - `city` string — employee address city - `state` string — employee address state code (two letters) - `zip` string — employee address ZIP code - `country` string — employee address country (two letters) - `position` string — position in the company - `appliedForSsn` boolean — Flag to indicate that the employee has applied for SSN - `provider` object - `account` string, required — W4 provider account identifier - `status` 'error' | 'pending' | 'pendingReview' | 'inProgress' | 'completed', required - `employeeId` string — employee identifier on w4 provider system - `employmentId` number — employment identifier on w4 provider system - `submissions` object[] - `submissionId` string — w4 submission identifier on w4 provider system - `status` 'rejected' | 'accepted' | 'error' | 'pending' | 'missing' — Workbright assigned document status - `documentId` string — Workbright ID of the document Attached to the Submission - `documentName` string — Title of the document Attached to the Submission - `rejected` boolean — is w4 submission rejected - `rejectedReason` string — reason of the rejection - `restarted` boolean — Flag to indicate that the profile has been restarted - `restartedReason` string — reason of the restart - `totalDocumentAssignments` number - `bypassedOptionalForms` boolean - `auditLog` object[] - `name` string - `actorType` 'worker' | 'employer' - `tagsUuids` string[] - `tags` object[] - `uuid` string, uuid, required - `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 - `label` string - `companyUuid` string, uuid, required - `archived` boolean — Flag to indicate the visibility of this W4 profile - `firstAccessedAt` string, date-time - `section0SubmittedAt` string, date-time - `askForTaxReciprocity` boolean — Flag to indicate if the worker should be asked for tax reciprocity - `optInTaxReciprocity` boolean — Flag to indicate if the worker opted in for tax reciprocity - `meta` ResponsesPartMeta - `timestamp` string, date-time, required - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE' - `path` string - `jti` string - `rid` string - `count` number - `status` string - `duration` number - `size` number ## Other responses - `500` — default error response --- [API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/versions/5f406c0e9462/schema)