v1
latestOpenAPI 3.0.12026-07-245752052.0 MBw4Profiles
find many 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.
get/api/servicetodo/w4Profiles
Query parameters
{
"limit": 10,
"order": [
"prop DESC"
]
}Response
One or many w4Profile documents found. Wrapped in a JsonAPI root response with collection of documents as data.
Example response
{
"data": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "963e0ba6-7efd-44b3-a4c9-52e938af1e51",
"company": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "Bojangles",
"slug": "bojangles",
"address": {
"address1": "55 rue du Faubourg-Saint-Honoré",
"address2": "Palais de l'Elysée",
"city": "Paris",
"zip": "75008",
"state": "Île-de-France",
"country": "France"
},
"metadata": {
"inferredProducts": [
"fountain_hire",
"ai_recruiter"
],
"outcomes": [
"hire_faster"
],
"hiresPerYear": "501-2000",
"industry": "retail",
"country": "US"
},
"legalName": "Bojangles OpCo, LLC.",
"ein": "00-0000000",
"supportPhone": "844-555-1337",
"alternativeSupportPhones": [
{
"number": "844-555-1337",
"source": "Hire"
}
],
"inactivityLockDays": 120,
"passwordPolicy": {
"minLength": 8,
"expireAfterDays": 90
},
"companyType": "internal",
"accountStatus": "live",
"companyContext": "Seasonal hiring ramps in Q3/Q4. Primary verticals: warehouse and delivery. Prefers SMS over email for candidate outreach.",
"timezone": "America/New_York"
},
"workerUuid": "e4f7e0a9-be1f-442e-8579-ea9c87fca4b2",
"employerUuid": "e4f7e0a9-be1f-442e-8579-ea9c87fca4b2",
"employer": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "fac03d3e-0140-4e23-b009-24dad6c4c30c",
"company": {
"uuid": "fac03d3e-0140-4e23-b009-24dad6c4c30c",
"slug": "my-company-aea8f39b"
},
"firstname": "John",
"lastname": "Doe",
"position": "Manager",
"displayFullName": "John Doe",
"email": "lyle.goatman@goatfarm.io",
"notificationEmail": "john.doe@example.com",
"firstSeenAt": "2023-04-24T00:00:00.000Z",
"lastSeenAt": "2023-04-25T00:00:00.000Z",
"timezone": "Europe/Paris",
"locale": "fr-FR",
"avatar": "https://i.pravatar.cc/500",
"invitedByUser": "6645dfca-8493-427f-a49a-cdbcec916381",
"unitaryLocationUuids": [
"aad12e0a-970e-4a6c-9149-05918bfb8a0f"
],
"unitaryLocations": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "San Francisco",
"description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
"street_address": "275 Sacramento St",
"address_2": "Unit 2",
"city": "San Francisco",
"state_code": "California",
"postal_code": "94105",
"country_code": "US",
"locationNotes": "Locker code: 21ABBS",
"timezone": "America/San_Francisco",
"language": "en_US",
"externalLocation": {
"source": "hire",
"externalCreatedAt": "2021-05-05T01:02:03.924Z"
}
}
],
"locationGroupUuids": [
"3c39b089-c19b-42bb-a8ad-2689e9fd75af"
],
"locationGroups": [
{
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a"
}
],
"locationUuids": [
"bf8f056f-0c79-4036-b07a-a28710976a9c"
],
"locations": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "San Francisco",
"description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
"street_address": "275 Sacramento St",
"address_2": "Unit 2",
"city": "San Francisco",
"state_code": "California",
"postal_code": "94105",
"country_code": "US",
"locationNotes": "Locker code: 21ABBS",
"timezone": "America/San_Francisco",
"language": "en_US",
"externalLocation": {
"source": "hire",
"externalCreatedAt": "2021-05-05T01:02:03.924Z"
}
}
],
"externalEmployer": {
"source": "hire"
},
"externalEmployeeId": "A123456",
"scimUserName": "john.doe@corp.local",
"active": true,
"invitationMessageEnabled": true
},
"worker": {
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"firstname": "Alice",
"lastname": "Doe",
"middlename": "Elizabeth",
"displayFullName": "Alice Doe",
"dashboardUrl": {
"slug": "alice-doe-2002",
"baseUrl": "https://employees.mcdonalds.com/"
},
"personalEmail": {
"email": "alice.doe@gmail.com",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"workEmail": {
"email": "alice.doe@fountain.com",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"mobilePhone": {
"number": "+331234567890",
"countryCode": "FR",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"whatsAppPhone": {
"number": "+521234567890",
"countryCode": "MX",
"verified": true,
"verifiedAt": "2025-03-09T00:00:00.000Z"
},
"homePhone": {
"number": "+331234567890",
"countryCode": "FR",
"verified": true,
"verifiedAt": "2023-03-24T00:00:00.000Z"
},
"homeAddress": {
"address1": "55 rue du Faubourg-Saint-Honoré",
"address2": "Palais de l'Elysée",
"city": "Paris",
"zip": "75008",
"state": "Île-de-France",
"country": "France"
},
"timezone": "Europe/Paris",
"locale": "fr-FR",
"companyUuid": "2ac58bbf-1e6c-4ab8-a614-350acea0e945",
"company": {
"uuid": "2ac58bbf-1e6c-4ab8-a614-350acea0e945",
"name": "My Company",
"slug": "my-company-a650bcf2"
},
"jobUuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"job": {
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"name": "Candle Sniffer",
"description": "Sniffer of Candles"
},
"jobIdentifiers": [
{
"jobUuid": "e1e3da43-915e-4ed9-97dc-175f458821ac",
"relationship": "primary"
}
],
"jobs": [
{
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"name": "Candle Sniffer",
"description": "Sniffer of Candles",
"allowUnscheduledShift": true
}
],
"brand": {
"name": "Pizza Hut"
},
"einUuid": "815deb86-f758-449f-87cd-81a3d7699296",
"ein": {
"uuid": "12-3456789",
"label": "Cool Company - Paris"
},
"locationUuid": "e3425972-86df-4384-9f40-8de005ba30b0",
"locationUuids": [
"e3425972-86df-4384-9f40-8de005ba30b0"
],
"locations": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"name": "San Francisco",
"description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
"street_address": "275 Sacramento St",
"address_2": "Unit 2",
"city": "San Francisco",
"state_code": "California",
"postal_code": "94105",
"country_code": "US",
"locationNotes": "Locker code: 21ABBS",
"timezone": "America/San_Francisco",
"language": "en_US",
"externalLocation": {
"source": "hire",
"externalCreatedAt": "2021-05-05T01:02:03.924Z"
}
}
],
"tags": [
{
"uuid": "7dcf6728-adf5-4c8c-b098-334b68b64ebe",
"name": "some tag"
}
],
"people": {
"uuid": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"index": 1,
"reasons": [
"ssn"
]
},
"rehire": {
"isRehire": true,
"uuid": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"reasons": [
"forcedFromAttribute"
]
},
"externalId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"externalSource": "UKG",
"externalSourceAccount": "fountain-sandbox",
"applicantId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"applicantSource": "Fountain Hire",
"backgroundCheckYardstikCandidateId": "6d5d014f-f118-4fbd-83f1-7baac578c123",
"dateOfBirth": "1987-12-24",
"startDate": "2023-04-26",
"hireDate": "2023-04-24",
"terminationDate": "2023-04-30",
"firstSeenAt": "2023-04-24T00:00:00.000Z",
"lastSeenAt": "2023-04-25T00:00:00.000Z",
"employmentStatus": {
"type": "inactive",
"subtype": "furloughed",
"lastStatusUpdateDate": "2023-04-25T00:00:00.000Z"
},
"avatar": "https://i.pravatar.cc/500",
"manager": {
"uuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"displayFullName": "Bob LeBoss"
},
"customAttributes": [
{
"customAttributeUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"value": "wanna work",
"customAttribute": {
"uuid": "8223636c5-47f4-43cc-963a-1d1d4e22b665",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"label": "Important Attr",
"key": "can_u_work",
"dataType": "string",
"description": "Important Attr",
"resource": "ComplianceCheckTemplate",
"resourceIdentifier": "38e7869d-6c42-406f-93e4-5fa687d7f09a",
"hireDataKeyId": 1
}
}
],
"segmentEnabled": true,
"segmentUuids": [
"uuidSegment1",
"uuidSegment2"
],
"messagingEnabled": true,
"importProvider": "hire",
"technicalOptions": {
"lockEin": true
},
"ssn": "123-45-6789",
"securityGroupUuids": [
"887436c5-47f4-43cc-963a-1d1d4e21f665"
],
"openingUuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"forceRecordSessionReplayUntil": "2023-04-24T00:00:00.000Z",
"smsOptOut": {
"optedOutAt": "2023-04-24T00:00:00.000Z",
"optedOutByAudience": "worker",
"optedOutByAudienceUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"optedOutOverrideByAudienceUuid": "admin-user-uuid",
"optedOutOverrideAt": "2023-04-24T00:00:00.000Z"
},
"whatsAppOptOut": {
"optedOutAt": "2023-04-24T00:00:00.000Z",
"optedOutByAudience": "worker",
"optedOutByAudienceUuid": "887436c5-47f4-43cc-963a-1d1d4e21f665",
"optedOutOverrideByAudienceUuid": "admin-user-uuid",
"optedOutOverrideAt": "2023-04-24T00:00:00.000Z"
},
"opening": {
"uuid": "0387e696-0285-4b6b-8ffc-04d85c13d547",
"title": "Opening 1"
}
},
"peopleUuid": "e4f7e0a9-be1f-442e-8579-ea9c87fca4b2",
"workerUuids": [
"e4f7e0a9-be1f-442e-8579-ea9c87fca4b2",
"963e0ba6-7efd-44b3-a4c9-52e938af1e51"
],
"w4Provider": "workbright",
"information": {
"email": "john.doe@mail.net",
"firstName": "John",
"lastName": "Doe",
"middleName": "Junior",
"birthdate": "1990-10-21",
"phone": "844-555-1337",
"gender": "M",
"nickname": "JJ",
"ssn": "123-45-6789",
"startDate": "2023-11-20",
"endDate": "2025-11-20",
"hireDate": "2023-10-31",
"address": {
"street": "10 main street",
"apt": "4B",
"city": "Boston",
"state": "MA",
"zip": "02108",
"country": "US"
},
"position": "manager"
},
"provider": {
"account": "fountain-sandbox",
"status": "pending",
"employeeId": "6578",
"employmentId": 1234,
"submissions": [
{
"submissionId": "4874",
"status": "pending",
"documentId": "w4",
"documentName": "W4 State Form",
"rejectedReason": "typo in firstname"
}
],
"restartedReason": "technical issue"
},
"tags": [
{
"uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
"createdAt": "2021-05-05T01:02:03.924Z",
"createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
"lastUpdatedAt": "2021-05-05T04:05:06.924Z",
"lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
"lastUpdatedByAudience": "employer",
"lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
"lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
"lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
"lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
"companyUuid": "963e0ba6-7efd-44b3-a4c9-52e938af1e51"
}
],
"firstAccessedAt": "2024-09-20T10:39:00.000Z",
"section0SubmittedAt": "2025-08-01T10:51:00.000Z"
}
],
"meta": {
"timestamp": "2021-05-05T09:47:58.924Z",
"verb": "GET",
"path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
"jti": "%cQN3RIGp",
"rid": "$2d2zkHZ5",
"count": 1,
"status": "200",
"duration": 17,
"size": 1234
}
}