> ## 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. # Search CoworkerDeliveries > Search and list CoworkerDelivery records with filtering, sorting, and pagination. 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 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-List`** role. ## Enums | Value | Name | | ----- | --------- | | 0 | None | | 1 | Mail | | 2 | Parcel | | 3 | Check | | 4 | Publicity | | 5 | Other | | Value | Name | | ----- | -------------------------- | | 0 | None | | 1 | StoreForCollection | | 2 | Forward | | 3 | OpenScanForward | | 4 | OpenScanRecycle | | 5 | OpenScanShred | | 6 | OpenScanStoreForCollection | | 7 | Recycle | | 8 | ReturnToSender | | 9 | Shred | | 10 | DepositCheck | | 11 | Unknown | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by Business Id. Filter by Coworker Id. Filter by Coworker Coworker Type. Filter by full name of the customer the delivery is for. Filter by email address of the customer the delivery is for. Filter by billing name of the customer the delivery is for. Filter by company name of the customer the delivery is for. Filter by team names the customer belongs to. Filter by Contract Contact Id. Filter by full name of the contract contact the delivery is for. Filter by email address of the contract contact the delivery is for. Filter by short label or description identifying the delivery item. Filter by physical location where the delivery is being stored (e.g. mailroom shelf). Filter by name of the staff member who received the delivery. Filter by free-text notes about the delivery. Filter by File Data File Name. Filter by New File Data Url. Filter by Clear File Data File. Filter by Signature File Name. Filter by New Signature Url. Filter by Clear Signature File. Filter by Scanned File Data File Name. Filter by New Scanned File Data Url. Filter by Clear Scanned File Data File. Filter by Forwarded File Data File Name. Filter by New Forwarded File Data Url. Filter by Clear Forwarded File Data File. Filter by whether the delivery has been processed according to the handling preference. Filter by whether the customer has collected the delivery. Filter by whether the customer must sign upon collection. Filter by whether the customer has signed for the delivery. Filter by Notified. Filter by date and time the customer collected the delivery. Filter by Billed. Filter by type of delivery item (Mail, Parcel, Check, Publicity, or Other). Filter by how the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred). Filter by whether the enclosed check has been deposited. Filter by whether the delivery has been forwarded to the customer. Filter by whether the delivery contents have been scanned. Filter by whether the delivery has been recycled. Filter by whether the delivery has been shredded. Filter by whether the delivery is being held for customer collection. Filter by whether the delivery has been returned to sender. Filter by date and time the check was deposited. Filter by date and time the delivery was forwarded. Filter by date and time the delivery contents were scanned. Filter by date and time the delivery was recycled. Filter by date and time the delivery was shredded. Filter by date and time the delivery was placed in storage for collection. Filter by date and time the delivery was returned to sender. Filter by Forwarding Address Unique Id. Filter by Check Deposited Product Unique Id. Filter by Forwarded Product Unique Id. Filter by Scanned Product Unique Id. Filter by Recycled Product Unique Id. Filter by Shredded Product Unique Id. Filter by Stored For Collection Product Unique Id. Filter by Returned To Sender Product Unique Id. Filter by Collected Product Unique Id. ### Range Filters Filter by date and time the customer collected the delivery greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the customer collected the delivery less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the check was deposited greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the check was deposited less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was forwarded greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was forwarded less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery contents were scanned greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery contents were scanned less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was recycled greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was recycled less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was shredded greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was shredded less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was placed in storage for collection greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was placed in storage for collection less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was returned to sender greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time the delivery was returned to sender less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/coworkerdeliveries?page=1&size=15&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/coworkerdeliveries?' + new URLSearchParams({ page: 1, size: 15, orderBy: 'Name', dir: 1 // Ascending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/coworkerdeliveries', params={ 'page': 1, 'size': 15, 'orderBy': 'Name', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Filtering by Name ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/coworkerdeliveries?CoworkerDelivery_Name=example-value&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/coworkerdeliveries?' + new URLSearchParams({ CoworkerDelivery_Name: 'example-value', orderBy: 'Name', dir: 1 }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/coworkerdeliveries', params={ 'CoworkerDelivery_Name': 'example-value', 'orderBy': 'Name', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Range filters ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/coworkerdeliveries?from_CoworkerDelivery_UpdatedOn=2025-01-01T00:00&to_CoworkerDelivery_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/coworkerdeliveries?' + new URLSearchParams({ from_CoworkerDelivery_UpdatedOn: '2025-01-01T00:00', to_CoworkerDelivery_UpdatedOn: '2025-12-31T23:59', orderBy: 'UpdatedOn', dir: 1 // Descending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/coworkerdeliveries', params={ 'from_CoworkerDelivery_UpdatedOn': '2025-01-01T00:00', 'to_CoworkerDelivery_UpdatedOn': '2025-12-31T23:59', 'orderBy': 'UpdatedOn', 'dir': 1 // Descending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ## Response ### 200 The list of CoworkerDelivery records matching the query. See the [Get one CoworkerDelivery](/rest-api/spaces/get-coworkerdeliveries-by-id) endpoint for the full list of properties returned for each record. **Partial records** — The listing endpoint returns a summary representation of each CoworkerDelivery. The following fields are **not populated** in the `Records[]` response: `Notes`, `RequiresSignature`, `Signed`. To get all fields, fetch the full record using the [Get one CoworkerDelivery](/rest-api/spaces/get-coworkerdeliveries-by-id) endpoint. **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "Records": [ { "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, "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, "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 } ], "CurrentPageSize": 15, "CurrentPage": 1, "CurrentOrderField": "Name", "CurrentSortDirection": 1, "FirstItem": 1, "HasNextPage": false, "HasPreviousPage": false, "LastItem": 1, "PageNumber": 1, "PageSize": 15, "TotalItems": 1, "TotalPages": 1 } ```