List

List

Use this endpoint to retrieve a list of all the new hire reports that have been created or transmitted to the states for a specific business.

Key Points

• The list can be filtered by TIN, BusinessId/PayerRef, and Filing Status
• You can also filter the results by a Date Range to narrow down results.

GET NewHire/Employee/List   

Run in Postman

Request Body

Field	Type	Description
BusinessId	string	Unique Identifier of the business.
PayerRef	string	Unique identifier of the payer. Set by the client in the endpoint Business/RequestByUrl.
TIN	string	Tax Identification Number of business.
Page	number	Pulls the records listed in the page selected
PageSize	number	Number of NewHire records to be listed in each page. Note: PageSize can be maximum of 100
Status	string	List the NewHire records based on the status Allowed values CREATED, SENTTOAGENCY, TRANSMITTED, ACCEPTED, REJECTED

Response Body

Field	Type	Description
NewHireRecords	object	Returns detailed information of the NewHire form records.
SubmissionId	Guid	Unique identifier of a submission.
BusinessId	Guid	Unique Identifier of the business
PayerRef	string	Unique identifier of the payer.
RecordId	Guid	Unique identifier of a record
EmployeeId	Guid	Unique Identifier of the business
EmpRef	string	Unique identifier of the payer.
ReportingState	string	Reporting state.
Status	string	Returns the status of the records.
StatusTs	string	Returns date and time of return created.
Info	string	Returns information about the Federal Filing service.
Errors	object[]	Shows error information of state returns of New Hire form
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error
TotalRecords	number	Total number of records.
TotalPages	number	Total number of pages.
Page	number	Pulls the page number of the page selected
PageSize	number	Number of NewHire records to be listed in each page.

Request Params

"newhire/employee/List?State=SC&BusinessId=07e6d7d9-5463-43d2-a272-14dc563cb5e0&TIN=001687743&Status=TRANSMITTED&Page=1&PageSize=25"

Response JSON

200

Success Response - This is a sample response for successful API requests.

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "NewHireRecords": [
      {
          "BusinessId": "07e6d7d9-5463-43d2-a272-14dc563cb5e0",
          "SubmissionId": "01993cc2-65a7-749f-ae9f-11228a524981",
          "PayerRef": null,
          "RecordId": "01993cc2-67a6-72ba-91d7-3e21e6ed3310",
          "ReportingState": "SC",
          "EmployeeId": "b3a91620-d26c-421e-95c6-1176522f105a",
          "EmpRef": "2344",
          "Status": "TRANSMITTED",
          "StatusTs": "2025-09-12T07:14:03.113Z",
          "Info": null,
          "Errors": null
      }
               ],
  "TotalRecords": 1,
  "TotalPages": 1,
  "PageSize": 100,
  "Errors": null
}

400

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
  "StatusCode": "400",
  "StatusName": "BadRequest",
  "StatusMessage": "Validation error has occurred",
  "NewHireRecords": null,
  "Errors": [
      {
          "Id": "S00-000192",
          "Name": "Business Id",
          "Message": "Invalid BusinessId. The given BusinessId does not match with any of the BusinessIds created in your account."
      }
  ]
}

401

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
  "StatusCode": 401,
  "StatusName": "Unauthorized",
  "StatusMessage": "Invalid authorization credentials",
  "Errors": [
      {
          "Id": "AUTH-100018",
          "Name": "Authorization",
          "Message": "JWT EXPIRED"
      }
  ]
}