> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one CoworkerDelivery

> Retrieve a single CoworkerDelivery record by its Id.

A **CoworkerDelivery** tracks a delivery (mail, parcel, check, or other item) received on behalf of a customer at a location, along with its current processing status and the customer's handling preference.

Each delivery records **who** it is for (`CoworkerId` or `ContractContactId`), **what** it is (`DeliveryType`), and **how** the customer wants it handled (`HandlingPreference`). Staff can then mark the delivery through its lifecycle — processed, collected, forwarded, scanned, recycled, shredded, or returned to sender — with corresponding timestamps.

Handling preferences control what happens to the delivery:

| HandlingPreference         | Meaning                                        |
| -------------------------- | ---------------------------------------------- |
| StoreForCollection         | Hold for the customer to pick up               |
| Forward                    | Forward to the customer's address              |
| OpenScanForward            | Open, scan contents, then forward the original |
| OpenScanRecycle            | Open, scan contents, then recycle the original |
| OpenScanShred              | Open, scan contents, then shred the original   |
| OpenScanStoreForCollection | Open, scan contents, then hold for collection  |
| Recycle                    | Recycle the delivery                           |
| ReturnToSender             | Return the delivery to the sender              |
| Shred                      | Shred the delivery                             |
| DepositCheck               | Deposit the enclosed check                     |

Deliveries can also have attached files — for example, a scanned copy of the contents (`NewScannedFileDataUrl`), a forwarding receipt (`NewForwardedFileDataUrl`), or a collection signature (`NewSignatureUrl`).

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`CoworkerDelivery-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CoworkerDelivery record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkerdeliveries/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkerdeliveries/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/spaces/coworkerdeliveries/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  Business Id.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  Coworker Id.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  Coworker Coworker Type.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the customer the delivery is for.
</ResponseField>

<ResponseField name="CoworkerEmail" type="string">
  Email address of the customer the delivery is for.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Billing name of the customer the delivery is for.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the customer the delivery is for.
</ResponseField>

<ResponseField name="CoworkerTeamNames" type="string">
  Team names the customer belongs to.
</ResponseField>

<ResponseField name="ContractContactId" type="integer">
  Contract Contact Id.
</ResponseField>

<ResponseField name="ContractContactFullName" type="string">
  Full name of the contract contact the delivery is for.
</ResponseField>

<ResponseField name="ContractContactEmail" type="string">
  Email address of the contract contact the delivery is for.
</ResponseField>

<ResponseField name="Name" type="string">
  Short label or description identifying the delivery item.
</ResponseField>

<ResponseField name="Location" type="string">
  Physical location where the delivery is being stored (e.g. mailroom shelf).
</ResponseField>

<ResponseField name="ReceivedBy" type="string">
  Name of the staff member who received the delivery.
</ResponseField>

<ResponseField name="Notes" type="string">
  Free-text notes about the delivery.
</ResponseField>

<ResponseField name="FileDataFileName" type="string">
  File Data File Name.
</ResponseField>

<ResponseField name="NewFileDataUrl" type="string">
  New File Data Url.
</ResponseField>

<ResponseField name="ClearFileDataFile" type="boolean">
  Clear File Data File.
</ResponseField>

<ResponseField name="SignatureFileName" type="string">
  Signature File Name.
</ResponseField>

<ResponseField name="NewSignatureUrl" type="string">
  New Signature Url.
</ResponseField>

<ResponseField name="ClearSignatureFile" type="boolean">
  Clear Signature File.
</ResponseField>

<ResponseField name="ScannedFileDataFileName" type="string">
  Scanned File Data File Name.
</ResponseField>

<ResponseField name="NewScannedFileDataUrl" type="string">
  New Scanned File Data Url.
</ResponseField>

<ResponseField name="ClearScannedFileDataFile" type="boolean">
  Clear Scanned File Data File.
</ResponseField>

<ResponseField name="ForwardedFileDataFileName" type="string">
  Forwarded File Data File Name.
</ResponseField>

<ResponseField name="NewForwardedFileDataUrl" type="string">
  New Forwarded File Data Url.
</ResponseField>

<ResponseField name="ClearForwardedFileDataFile" type="boolean">
  Clear Forwarded File Data File.
</ResponseField>

<ResponseField name="Processed" type="boolean">
  Whether the delivery has been processed according to the handling preference.
</ResponseField>

<ResponseField name="Collected" type="boolean">
  Whether the customer has collected the delivery.
</ResponseField>

<ResponseField name="RequiresSignature" type="boolean">
  Whether the customer must sign upon collection.
</ResponseField>

<ResponseField name="Signed" type="boolean">
  Whether the customer has signed for the delivery.
</ResponseField>

<ResponseField name="Notified" type="boolean">
  Notified.
</ResponseField>

<ResponseField name="CollectedOn" type="string">
  Date and time the customer collected the delivery.
</ResponseField>

<ResponseField name="Billed" type="boolean">
  Billed.
</ResponseField>

<ResponseField name="DeliveryType" type="integer">
  Type of delivery item (Mail, Parcel, Check, Publicity, or Other). See `eDeliveryType` enum values: `0` = None, `1` = Mail, `2` = Parcel, `3` = Check, `4` = Publicity, `5` = Other.
</ResponseField>

<ResponseField name="HandlingPreference" type="integer">
  How the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred).
</ResponseField>

<ResponseField name="CheckDeposited" type="boolean">
  Whether the enclosed check has been deposited.
</ResponseField>

<ResponseField name="Forwarded" type="boolean">
  Whether the delivery has been forwarded to the customer.
</ResponseField>

<ResponseField name="Scanned" type="boolean">
  Whether the delivery contents have been scanned.
</ResponseField>

<ResponseField name="Recycled" type="boolean">
  Whether the delivery has been recycled.
</ResponseField>

<ResponseField name="Shredded" type="boolean">
  Whether the delivery has been shredded.
</ResponseField>

<ResponseField name="StoredForCollection" type="boolean">
  Whether the delivery is being held for customer collection.
</ResponseField>

<ResponseField name="ReturnedToSender" type="boolean">
  Whether the delivery has been returned to sender.
</ResponseField>

<ResponseField name="CheckDepositedOn" type="string">
  Date and time the check was deposited.
</ResponseField>

<ResponseField name="ForwardedOn" type="string">
  Date and time the delivery was forwarded.
</ResponseField>

<ResponseField name="ScannedOn" type="string">
  Date and time the delivery contents were scanned.
</ResponseField>

<ResponseField name="RecycledOn" type="string">
  Date and time the delivery was recycled.
</ResponseField>

<ResponseField name="ShreddedOn" type="string">
  Date and time the delivery was shredded.
</ResponseField>

<ResponseField name="StoredForCollectionOn" type="string">
  Date and time the delivery was placed in storage for collection.
</ResponseField>

<ResponseField name="ReturnedToSenderOn" type="string">
  Date and time the delivery was returned to sender.
</ResponseField>

<ResponseField name="ForwardingAddressUniqueId" type="string">
  Forwarding Address Unique Id.
</ResponseField>

<ResponseField name="CheckDepositedProductUniqueId" type="string">
  Check Deposited Product Unique Id.
</ResponseField>

<ResponseField name="ForwardedProductUniqueId" type="string">
  Forwarded Product Unique Id.
</ResponseField>

<ResponseField name="ScannedProductUniqueId" type="string">
  Scanned Product Unique Id.
</ResponseField>

<ResponseField name="RecycledProductUniqueId" type="string">
  Recycled Product Unique Id.
</ResponseField>

<ResponseField name="ShreddedProductUniqueId" type="string">
  Shredded Product Unique Id.
</ResponseField>

<ResponseField name="StoredForCollectionProductUniqueId" type="string">
  Stored For Collection Product Unique Id.
</ResponseField>

<ResponseField name="ReturnedToSenderProductUniqueId" type="string">
  Returned To Sender Product Unique Id.
</ResponseField>

<ResponseField name="CollectedProductUniqueId" type="string">
  Collected Product Unique Id.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "CoworkerId": null,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerEmail": null,
  "CoworkerBillingName": null,
  "CoworkerCompanyName": null,
  "CoworkerTeamNames": null,
  "ContractContactId": null,
  "ContractContactFullName": null,
  "ContractContactEmail": null,
  "Name": "",
  "Location": "",
  "ReceivedBy": null,
  "Notes": null,
  "FileDataFileName": null,
  "NewFileDataUrl": null,
  "ClearFileDataFile": null,
  "SignatureFileName": null,
  "NewSignatureUrl": null,
  "ClearSignatureFile": null,
  "ScannedFileDataFileName": null,
  "NewScannedFileDataUrl": null,
  "ClearScannedFileDataFile": null,
  "ForwardedFileDataFileName": null,
  "NewForwardedFileDataUrl": null,
  "ClearForwardedFileDataFile": null,
  "Processed": false,
  "Collected": false,
  "RequiresSignature": false,
  "Signed": false,
  "Notified": false,
  "CollectedOn": null,
  "Billed": false,
  "DeliveryType": 0,
  "HandlingPreference": 0,
  "CheckDeposited": false,
  "Forwarded": false,
  "Scanned": false,
  "Recycled": false,
  "Shredded": false,
  "StoredForCollection": false,
  "ReturnedToSender": false,
  "CheckDepositedOn": null,
  "ForwardedOn": null,
  "ScannedOn": null,
  "RecycledOn": null,
  "ShreddedOn": null,
  "StoredForCollectionOn": null,
  "ReturnedToSenderOn": null,
  "ForwardingAddressUniqueId": null,
  "CheckDepositedProductUniqueId": null,
  "ForwardedProductUniqueId": null,
  "ScannedProductUniqueId": null,
  "RecycledProductUniqueId": null,
  "ShreddedProductUniqueId": null,
  "StoredForCollectionProductUniqueId": null,
  "ReturnedToSenderProductUniqueId": null,
  "CollectedProductUniqueId": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerDelivery Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```