Parameters
| Parameter | Description |
|---|---|
| Filter | Filter results based on a filter expression.For example:/mobileUserAccounts/associateOID eq ‘G4O73G9Z62SL2NFM’./mobileUserAccounts/organizationOID eq ‘ABCDEFGH’./mobileUserAccounts/personName/givenName eq ‘John’./mobileUserAccounts/personName/familyName1 eq ‘Smith’./mobileUserAccounts/birthDate eq ‘01-01-1970’.For more information, please visit the ADP OData Protocol documentation. |
| Limit | The maximum number of records to return. |
| Offset | The offset of the item at which to begin the response. |
Example Output
{ "workers": [ { "associateOID": "G3R47DSRZK5TRCFJ", "workerID": { "idValue": "3WC5KYA4L" }, "person": { "birthDate": "0000-01-01", "genderCode": { "codeValue": "M", "shortName": "Male", "longName": "Male" }, "maritalStatusCode": { "codeValue": "S", "shortName": "Single" }, "socialInsurancePrograms": [ { "nameCode": { "codeValue": "Medicare", "shortName": "Medicare" }, "coveredIndicator": true } ], "tobaccoUserIndicator": false, "disabledIndicator": false, "ethnicityCode": { "codeValue": "4", "shortName": "4", "longName": "Not Hispanic or Latino" }, "raceCode": { "codeValue": "1", "shortName": "White", "longName": "White" }, "customFieldGroup": { "amountFields": [ { "itemID": "169731481494_452", "nameCode": { "codeValue": "Rate", "shortName": "Rate" } } ], "stringFields": [ { "itemID": "169731474432_105", "nameCode": { "codeValue": "PR code", "shortName": "PR code" } } ] }, "governmentIDs": [ { "itemID": "67786684N", "idValue": "XXX-XX-3761", "nameCode": { "codeValue": "SSN", "longName": "Social Security Number" }, "countryCode": "US" } ], "legalName": { "givenName": "test761", "middleName": "two", "familyName1": "NewHire", "formattedName": "NewHire, test761 two" }, "legalAddress": { "nameCode": { "codeValue": "Personal Address 1", "shortName": "Personal Address 1" }, "lineOne": "line 1", "lineTwo": "line 2", "lineThree": "Address line 3", "cityName": "New Jersey", "countrySubdivisionLevel1": { "subdivisionType": "StateTerritory", "codeValue": "NJ", "shortName": "New Jersey" }, "countryCode": "US", "postalCode": "30041" }, "communication": { "landlines": [ { "itemID": "CC1_169733208370_10", "nameCode": { "codeValue": "Home Phone", "shortName": "Home Phone" }, "countryDialing": "1", "areaDialing": "973", "dialNumber": "2345432", "access": "1", "formattedNumber": "(973) 234-5432" } ], "mobiles": [ { "itemID": "CC1_169733208370_9", "nameCode": { "codeValue": "Personal Cell", "shortName": "Personal Cell" }, "countryDialing": "1", "areaDialing": "770", "dialNumber": "2398790", "access": "1", "formattedNumber": "(770) 239-8790" } ], "faxes": [ { "itemID": "CC1_169733208370_11", "nameCode": { "codeValue": "Home Fax", "shortName": "Home Fax" }, "countryDialing": "91", "areaDialing": "770", "dialNumber": "2345432890890790", "access": "429", "formattedNumber": "+91 (429) 770 2345432890890790" } ], "emails": [ { "nameCode": { "codeValue": "Personal E-mail", "shortName": "Personal E-mail" }, "emailUri": "test761@newhirepersonal.com" } ] } }, "workerDates": { "originalHireDate": "2019-07-12" }, "workerStatus": { "statusCode": { "codeValue": "Active" } }, "businessCommunication": { "landlines": [ { "itemID": "CC1_169733208370_14", "nameCode": { "codeValue": "Work Phone", "shortName": "Work Phone" }, "countryDialing": "91", "areaDialing": "770", "dialNumber": "2345432890890793", "access": "429", "formattedNumber": "+91 (429) 770 2345432890890793" } ], "mobiles": [ { "itemID": "CC1_169733208370_13", "nameCode": { "codeValue": "Work Cell", "shortName": "Work Cell" }, "countryDialing": "91", "areaDialing": "770", "dialNumber": "2345432890890794", "access": "429", "formattedNumber": "+91 (429) 770 2345432890890794" } ], "faxes": [ { "itemID": "CC1_169733208370_15", "nameCode": { "codeValue": "Work Fax", "shortName": "Work Fax" }, "countryDialing": "91", "areaDialing": "770", "dialNumber": "2345432890890795", "access": "429", "formattedNumber": "+91 (429) 770 2345432890890795" } ], "pagers": [ { "itemID": "CC1_169733208370_16", "nameCode": { "codeValue": "Work Pager", "shortName": "Work Pager" }, "countryDialing": "91", "areaDialing": "770", "dialNumber": "2345432890890796", "access": "429", "formattedNumber": "+91 (429) 770 2345432890890796" } ], "emails": [ { "itemID": "Business", "nameCode": { "codeValue": "Work E-mail", "shortName": "Work E-mail" }, "emailUri": "test761@lnewhireprofessional.com" } ] }, "workAssignments": [ { "itemID": "67786684N", "primaryIndicator": true, "hireDate": "2019-07-12", "actualStartDate": "2019-07-12", "assignmentStatus": { "statusCode": { "codeValue": "A", "shortName": "Active" } }, "jobCode": { "codeValue": "PT", "shortName": "**" }, "jobTitle": "PT - **", "positionID": "94N023114", "homeOrganizationalUnits": [ { "nameCode": { "codeValue": "B", "shortName": "test" }, "typeCode": { "codeValue": "Business Unit", "shortName": "Business Unit" } } ], "assignedOrganizationalUnits": [ { "nameCode": { "codeValue": "B", "shortName": "test" }, "typeCode": { "codeValue": "Business Unit", "shortName": "Business Unit" } } ], "payCycleCode": { "codeValue": "W", "shortName": "Weekly" }, "standardPayPeriodHours": { "hoursQuantity": 40 }, "baseRemuneration": { "payPeriodRateAmount": { "nameCode": { "codeValue": "Salary", "shortName": "Salary" }, "amountValue": 12332, "currencyCode": "USD" }, "effectiveDate": "2019-07-12" }, "payrollGroupCode": "94N", "payrollScheduleGroupID": "Use Period End Date 1 on checks", "payrollFileNumber": "023114", "managementPositionIndicator": false } ] } ], "meta": null, "confirmMessage": null}
Workflow Library Example
Search Employees with Adp and Send Results Via Email
Preview this Workflow on desktop