GET v1/system/{systemKey}/external-processing-queues?type={type}&status={status}

Request Information

URI Parameters

Name	Type	Additional information
systemKey	globally unique identifier	Required
type	QueueItemProcessorType	None.
status	ExternalProcessingQueueStatus	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ExternalProcessingQueueDTO

Name	Type	Additional information
Id	GlobalEntityKeyOfIExternalProcessingQueue	None.
TrackingKey	string	None.
Status	ExternalProcessingQueueStatus	None.
ExternalPartner	ExternalPartners	None.
ProcessType	QueueItemProcessorType	None.
Source	string	None.
StatusMessage	string	None.
RetryCount	integer	None.
LastProcessedOn	date	None.
Notes	string	None.
SystemKey	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": "<empty>",
    "trackingKey": "sample string 1",
    "status": "Unprocessed",
    "externalPartner": "GetHired",
    "processType": "AddEmployee",
    "source": "sample string 2",
    "statusMessage": "sample string 3",
    "retryCount": 4,
    "lastProcessedOn": "2026-09-13T21:32:20.5238555Z",
    "notes": "sample string 5",
    "systemKey": "0adecf29-115a-4abf-847c-97e27303510a"
  },
  {
    "id": "<empty>",
    "trackingKey": "sample string 1",
    "status": "Unprocessed",
    "externalPartner": "GetHired",
    "processType": "AddEmployee",
    "source": "sample string 2",
    "statusMessage": "sample string 3",
    "retryCount": 4,
    "lastProcessedOn": "2026-09-13T21:32:20.5238555Z",
    "notes": "sample string 5",
    "systemKey": "0adecf29-115a-4abf-847c-97e27303510a"
  }
]

text/xml

Sample:

<ArrayOfExternalProcessingQueueDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExternalProcessingQueueDTO>
    <ExternalPartner>GetHired</ExternalPartner>
    <Id xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </Id>
    <LastProcessedOn>2026-09-13T17:32:20.5238555-04:00</LastProcessedOn>
    <Notes>sample string 5</Notes>
    <ProcessType>AddEmployee</ProcessType>
    <RetryCount>4</RetryCount>
    <Source>sample string 2</Source>
    <Status>Unprocessed</Status>
    <StatusMessage>sample string 3</StatusMessage>
    <SystemKey>0adecf29-115a-4abf-847c-97e27303510a</SystemKey>
    <TrackingKey>sample string 1</TrackingKey>
  </ExternalProcessingQueueDTO>
  <ExternalProcessingQueueDTO>
    <ExternalPartner>GetHired</ExternalPartner>
    <Id xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </Id>
    <LastProcessedOn>2026-09-13T17:32:20.5238555-04:00</LastProcessedOn>
    <Notes>sample string 5</Notes>
    <ProcessType>AddEmployee</ProcessType>
    <RetryCount>4</RetryCount>
    <Source>sample string 2</Source>
    <Status>Unprocessed</Status>
    <StatusMessage>sample string 3</StatusMessage>
    <SystemKey>0adecf29-115a-4abf-847c-97e27303510a</SystemKey>
    <TrackingKey>sample string 1</TrackingKey>
  </ExternalProcessingQueueDTO>
</ArrayOfExternalProcessingQueueDTO>