GET papi/v1/employeeoutbound/Employees?levelName={levelName}&locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncDate={lastSyncDate}&status={status}

Security

Secured API

Request Information

URI Parameters

Name	Type	Additional information
levelName	string	None.
locationCode	string	None.
dateFrom	date	None.
dateTo	date	None.
lastSyncDate	date	None.
status	string	None.

Required Headers

Name	Description	Sample	Type	Default
UserId	Represents the value of the user id. Allow multiple values: no.	1000	integer	None
Authorization	Represents the value of the authentication token. Allow multiple values: no.	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ...	string	None
ConsumerId	Represents the value of the consumer id. Allow multiple values: no.	2426	integer	None

Optional Headers

Name	Description	Sample	Type	Default
ApplicationType	Represents the value of the consumer's application type. Allow multiple values: no.	1	ApplicationType	None
Accept-Language	Represents the value of the desired language for translations. Allow multiple values: yes.	es	string	en-US

Body Parameters

None.

Response Information

Resource Description

EmployeeOutbound

Name	Description	Type	Additional information
Employees		Collection of Employees	None.

Response Formats

application/json, text/json

Sample:

{
  "Employees": [
    {
      "EmploymentType": "sample string 2",
      "EmployeeID": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "Suffix": "sample string 7",
      "SocialSecurityNumber": "sample string 8",
      "DateOfbirth": "sample string 9",
      "Gender": "sample string 10",
      "Title": "sample string 11",
      "MaritalStatus": "sample string 12",
      "NumberOfDependents": 13,
      "EmploymentStatus": "sample string 14",
      "EmploymentStatusDate": "2025-11-04T16:09:13.164Z",
      "PrimaryLanguageSpoken": "sample string 16",
      "SecondaryLanguageSpoken": "sample string 17",
      "StreetAddress": "sample string 18",
      "City": "sample string 19",
      "Country": "sample string 20",
      "StateorProvince": "sample string 21",
      "ZiporPostalCode": "sample string 22",
      "PhoneNumberDay": "sample string 23",
      "PhoneNumberNight": "sample string 24",
      "EmailID": "sample string 25",
      "EmergencyContactDetails": "sample string 26",
      "NCCICode": "sample string 27",
      "NCCIOccupation": "sample string 28",
      "FEIN": "sample string 29",
      "LegalEntityName": "sample string 30",
      "Location": "sample string 31",
      "DepartmentName": "sample string 32",
      "Nationality": "sample string 33",
      "Ethnicity": "sample string 34",
      "PhysicalLocation": "sample string 35",
      "HireState": "sample string 36",
      "HireDate": "2025-11-04T16:09:13.164Z",
      "PayRateType": "sample string 38",
      "Wage": "sample string 39",
      "WorkingHoursPerDay": 40.1,
      "DaysPerWeek": [
        "sample string 1",
        "sample string 2"
      ],
      "EmployeeRole": "sample string 41",
      "PersonnelArea": "sample string 42",
      "SupervisorName": "sample string 43",
      "JobStartDate": "2025-11-04T16:09:13.164Z",
      "DateofTermination": "2025-11-04T16:09:13.164Z",
      "LicenseNumber": "sample string 46",
      "StateofLicense": "sample string 47",
      "IssueDate": "2025-11-04T16:09:13.164Z",
      "ExpirationDate": "2025-11-04T16:09:13.164Z",
      "CommercialDriverLicenseHolder": "sample string 50",
      "ClassType": "sample string 51",
      "Endorsements": "sample string 52",
      "Restrictions": "sample string 53",
      "CompanyDriverStartDate": "2025-11-04T16:09:13.164Z",
      "PreviouslyLicensedStates": [
        "sample string 1",
        "sample string 2"
      ],
      "RouteType": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "EmploymentType": "sample string 2",
      "EmployeeID": "sample string 3",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "Suffix": "sample string 7",
      "SocialSecurityNumber": "sample string 8",
      "DateOfbirth": "sample string 9",
      "Gender": "sample string 10",
      "Title": "sample string 11",
      "MaritalStatus": "sample string 12",
      "NumberOfDependents": 13,
      "EmploymentStatus": "sample string 14",
      "EmploymentStatusDate": "2025-11-04T16:09:13.164Z",
      "PrimaryLanguageSpoken": "sample string 16",
      "SecondaryLanguageSpoken": "sample string 17",
      "StreetAddress": "sample string 18",
      "City": "sample string 19",
      "Country": "sample string 20",
      "StateorProvince": "sample string 21",
      "ZiporPostalCode": "sample string 22",
      "PhoneNumberDay": "sample string 23",
      "PhoneNumberNight": "sample string 24",
      "EmailID": "sample string 25",
      "EmergencyContactDetails": "sample string 26",
      "NCCICode": "sample string 27",
      "NCCIOccupation": "sample string 28",
      "FEIN": "sample string 29",
      "LegalEntityName": "sample string 30",
      "Location": "sample string 31",
      "DepartmentName": "sample string 32",
      "Nationality": "sample string 33",
      "Ethnicity": "sample string 34",
      "PhysicalLocation": "sample string 35",
      "HireState": "sample string 36",
      "HireDate": "2025-11-04T16:09:13.164Z",
      "PayRateType": "sample string 38",
      "Wage": "sample string 39",
      "WorkingHoursPerDay": 40.1,
      "DaysPerWeek": [
        "sample string 1",
        "sample string 2"
      ],
      "EmployeeRole": "sample string 41",
      "PersonnelArea": "sample string 42",
      "SupervisorName": "sample string 43",
      "JobStartDate": "2025-11-04T16:09:13.164Z",
      "DateofTermination": "2025-11-04T16:09:13.164Z",
      "LicenseNumber": "sample string 46",
      "StateofLicense": "sample string 47",
      "IssueDate": "2025-11-04T16:09:13.164Z",
      "ExpirationDate": "2025-11-04T16:09:13.164Z",
      "CommercialDriverLicenseHolder": "sample string 50",
      "ClassType": "sample string 51",
      "Endorsements": "sample string 52",
      "Restrictions": "sample string 53",
      "CompanyDriverStartDate": "2025-11-04T16:09:13.164Z",
      "PreviouslyLicensedStates": [
        "sample string 1",
        "sample string 2"
      ],
      "RouteType": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<EmployeeOutbound xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Employees>
    <Employees>
      <EmploymentPK>sample string 1</EmploymentPK>
      <EmploymentType>sample string 2</EmploymentType>
      <EmployeeID>sample string 3</EmployeeID>
      <FirstName>sample string 4</FirstName>
      <MiddleName>sample string 5</MiddleName>
      <LastName>sample string 6</LastName>
      <Suffix>sample string 7</Suffix>
      <SocialSecurityNumber>sample string 8</SocialSecurityNumber>
      <DateOfbirth>sample string 9</DateOfbirth>
      <Gender>sample string 10</Gender>
      <Title>sample string 11</Title>
      <MaritalStatus>sample string 12</MaritalStatus>
      <NumberOfDependents>13</NumberOfDependents>
      <EmploymentStatus>sample string 14</EmploymentStatus>
      <EmploymentStatusDate>2025-11-04T11:09:13.1643071-05:00</EmploymentStatusDate>
      <PrimaryLanguageSpoken>sample string 16</PrimaryLanguageSpoken>
      <SecondaryLanguageSpoken>sample string 17</SecondaryLanguageSpoken>
      <StreetAddress>sample string 18</StreetAddress>
      <City>sample string 19</City>
      <Country>sample string 20</Country>
      <StateorProvince>sample string 21</StateorProvince>
      <ZiporPostalCode>sample string 22</ZiporPostalCode>
      <PhoneNumberDay>sample string 23</PhoneNumberDay>
      <PhoneNumberNight>sample string 24</PhoneNumberNight>
      <EmailID>sample string 25</EmailID>
      <EmergencyContactDetails>sample string 26</EmergencyContactDetails>
      <NCCICode>sample string 27</NCCICode>
      <NCCIOccupation>sample string 28</NCCIOccupation>
      <FEIN>sample string 29</FEIN>
      <LegalEntityName>sample string 30</LegalEntityName>
      <Location>sample string 31</Location>
      <DepartmentName>sample string 32</DepartmentName>
      <Nationality>sample string 33</Nationality>
      <Ethnicity>sample string 34</Ethnicity>
      <PhysicalLocation>sample string 35</PhysicalLocation>
      <HireState>sample string 36</HireState>
      <HireDate>2025-11-04T11:09:13.1643071-05:00</HireDate>
      <PayRateType>sample string 38</PayRateType>
      <Wage>sample string 39</Wage>
      <WorkingHoursPerDay>40.1</WorkingHoursPerDay>
      <DaysPerWeek>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </DaysPerWeek>
      <EmployeeRole>sample string 41</EmployeeRole>
      <PersonnelArea>sample string 42</PersonnelArea>
      <SupervisorName>sample string 43</SupervisorName>
      <JobStartDate>2025-11-04T11:09:13.1643071-05:00</JobStartDate>
      <DateofTermination>2025-11-04T11:09:13.1643071-05:00</DateofTermination>
      <LicenseNumber>sample string 46</LicenseNumber>
      <StateofLicense>sample string 47</StateofLicense>
      <IssueDate>2025-11-04T11:09:13.1643071-05:00</IssueDate>
      <ExpirationDate>2025-11-04T11:09:13.1643071-05:00</ExpirationDate>
      <CommercialDriverLicenseHolder>sample string 50</CommercialDriverLicenseHolder>
      <ClassType>sample string 51</ClassType>
      <Endorsements>sample string 52</Endorsements>
      <Restrictions>sample string 53</Restrictions>
      <CompanyDriverStartDate>2025-11-04T11:09:13.1643071-05:00</CompanyDriverStartDate>
      <PreviouslyLicensedStates>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </PreviouslyLicensedStates>
      <RouteType>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </RouteType>
    </Employees>
    <Employees>
      <EmploymentPK>sample string 1</EmploymentPK>
      <EmploymentType>sample string 2</EmploymentType>
      <EmployeeID>sample string 3</EmployeeID>
      <FirstName>sample string 4</FirstName>
      <MiddleName>sample string 5</MiddleName>
      <LastName>sample string 6</LastName>
      <Suffix>sample string 7</Suffix>
      <SocialSecurityNumber>sample string 8</SocialSecurityNumber>
      <DateOfbirth>sample string 9</DateOfbirth>
      <Gender>sample string 10</Gender>
      <Title>sample string 11</Title>
      <MaritalStatus>sample string 12</MaritalStatus>
      <NumberOfDependents>13</NumberOfDependents>
      <EmploymentStatus>sample string 14</EmploymentStatus>
      <EmploymentStatusDate>2025-11-04T11:09:13.1643071-05:00</EmploymentStatusDate>
      <PrimaryLanguageSpoken>sample string 16</PrimaryLanguageSpoken>
      <SecondaryLanguageSpoken>sample string 17</SecondaryLanguageSpoken>
      <StreetAddress>sample string 18</StreetAddress>
      <City>sample string 19</City>
      <Country>sample string 20</Country>
      <StateorProvince>sample string 21</StateorProvince>
      <ZiporPostalCode>sample string 22</ZiporPostalCode>
      <PhoneNumberDay>sample string 23</PhoneNumberDay>
      <PhoneNumberNight>sample string 24</PhoneNumberNight>
      <EmailID>sample string 25</EmailID>
      <EmergencyContactDetails>sample string 26</EmergencyContactDetails>
      <NCCICode>sample string 27</NCCICode>
      <NCCIOccupation>sample string 28</NCCIOccupation>
      <FEIN>sample string 29</FEIN>
      <LegalEntityName>sample string 30</LegalEntityName>
      <Location>sample string 31</Location>
      <DepartmentName>sample string 32</DepartmentName>
      <Nationality>sample string 33</Nationality>
      <Ethnicity>sample string 34</Ethnicity>
      <PhysicalLocation>sample string 35</PhysicalLocation>
      <HireState>sample string 36</HireState>
      <HireDate>2025-11-04T11:09:13.1643071-05:00</HireDate>
      <PayRateType>sample string 38</PayRateType>
      <Wage>sample string 39</Wage>
      <WorkingHoursPerDay>40.1</WorkingHoursPerDay>
      <DaysPerWeek>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </DaysPerWeek>
      <EmployeeRole>sample string 41</EmployeeRole>
      <PersonnelArea>sample string 42</PersonnelArea>
      <SupervisorName>sample string 43</SupervisorName>
      <JobStartDate>2025-11-04T11:09:13.1643071-05:00</JobStartDate>
      <DateofTermination>2025-11-04T11:09:13.1643071-05:00</DateofTermination>
      <LicenseNumber>sample string 46</LicenseNumber>
      <StateofLicense>sample string 47</StateofLicense>
      <IssueDate>2025-11-04T11:09:13.1643071-05:00</IssueDate>
      <ExpirationDate>2025-11-04T11:09:13.1643071-05:00</ExpirationDate>
      <CommercialDriverLicenseHolder>sample string 50</CommercialDriverLicenseHolder>
      <ClassType>sample string 51</ClassType>
      <Endorsements>sample string 52</Endorsements>
      <Restrictions>sample string 53</Restrictions>
      <CompanyDriverStartDate>2025-11-04T11:09:13.1643071-05:00</CompanyDriverStartDate>
      <PreviouslyLicensedStates>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </PreviouslyLicensedStates>
      <RouteType>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </RouteType>
    </Employees>
  </Employees>
</EmployeeOutbound>