GET v1/system/{systemKey}/external-processing-queues/{externalProcessingQueueKey}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| systemKey | globally unique identifier |
Required |
|
| externalProcessingQueueKey | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ExternalProcessingQueueDTO| Name | Description | 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:18.0108253Z",
"notes": "sample string 5",
"systemKey": "7b165aa3-8dbe-44eb-a1de-7e9a1f96466a"
}
text/xml
Sample:
<ExternalProcessingQueueDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<ExternalPartner>GetHired</ExternalPartner>
<Id xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d2p1:_entityKey>
<d2p1:_hasValue>false</d2p1:_hasValue>
<d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
</d2p1:_entityKey>
</Id>
<LastProcessedOn>2026-09-13T17:32:18.0108253-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>7b165aa3-8dbe-44eb-a1de-7e9a1f96466a</SystemKey>
<TrackingKey>sample string 1</TrackingKey>
</ExternalProcessingQueueDTO>