Search CoworkerDeliveries

Search and list CoworkerDelivery records with filtering, sorting, and pagination.

GET /api/spaces/coworkerdeliveries

Search CoworkerDeliveries

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkerdeliveries \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

eDeliveryType — DeliveryType values

Value	Name
0	None
1	Mail
2	Parcel
3	Check
4	Publicity
5	Other

eDeliveryHandlingPreference

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

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CoworkerDelivery_Business · integer

Filter by Business Id.

CoworkerDelivery_Coworker · integer

Filter by Coworker Id.

CoworkerDelivery_Coworker_CoworkerType · string

Filter by Coworker Coworker Type.

CoworkerDelivery_Coworker_FullName · string

Filter by full name of the customer the delivery is for.

CoworkerDelivery_Coworker_Email · string

Filter by email address of the customer the delivery is for.

CoworkerDelivery_Coworker_BillingName · string

Filter by billing name of the customer the delivery is for.

CoworkerDelivery_Coworker_CompanyName · string

Filter by company name of the customer the delivery is for.

CoworkerDelivery_Coworker_TeamNames · string

Filter by team names the customer belongs to.

CoworkerDelivery_ContractContact · integer

Filter by Contract Contact Id.

CoworkerDelivery_ContractContact_FullName · string

Filter by full name of the contract contact the delivery is for.

CoworkerDelivery_ContractContact_Email · string

Filter by email address of the contract contact the delivery is for.

CoworkerDelivery_Name · string

Filter by short label or description identifying the delivery item.

CoworkerDelivery_Location · string

Filter by physical location where the delivery is being stored (e.g. mailroom shelf).

CoworkerDelivery_ReceivedBy · string

Filter by name of the staff member who received the delivery.

CoworkerDelivery_Notes · string

Filter by free-text notes about the delivery.

CoworkerDelivery_FileDataFileName · string

Filter by File Data File Name.

CoworkerDelivery_NewFileDataUrl · string

Filter by New File Data Url.

CoworkerDelivery_ClearFileData · boolean

Filter by Clear File Data File.

CoworkerDelivery_SignatureFileName · string

Filter by Signature File Name.

CoworkerDelivery_NewSignatureUrl · string

Filter by New Signature Url.

CoworkerDelivery_ClearSignature · boolean

Filter by Clear Signature File.

CoworkerDelivery_ScannedFileDataFileName · string

Filter by Scanned File Data File Name.

CoworkerDelivery_NewScannedFileDataUrl · string

Filter by New Scanned File Data Url.

CoworkerDelivery_ClearScannedFileData · boolean

Filter by Clear Scanned File Data File.

CoworkerDelivery_ForwardedFileDataFileName · string

Filter by Forwarded File Data File Name.

CoworkerDelivery_NewForwardedFileDataUrl · string

Filter by New Forwarded File Data Url.

CoworkerDelivery_ClearForwardedFileData · boolean

Filter by Clear Forwarded File Data File.

CoworkerDelivery_Processed · boolean

Filter by whether the delivery has been processed according to the handling preference.

CoworkerDelivery_Collected · boolean

Filter by whether the customer has collected the delivery.

CoworkerDelivery_RequiresSignature · boolean

Filter by whether the customer must sign upon collection.

CoworkerDelivery_Signed · boolean

Filter by whether the customer has signed for the delivery.

CoworkerDelivery_Notified · boolean

Filter by Notified.

CoworkerDelivery_CollectedOn · string

Filter by date and time the customer collected the delivery.

CoworkerDelivery_Billed · boolean

Filter by Billed.

CoworkerDelivery_DeliveryType · integer

Filter by type of delivery item (Mail, Parcel, Check, Publicity, or Other).

CoworkerDelivery_HandlingPreference · integer

Filter by how the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred).

CoworkerDelivery_CheckDeposited · boolean

Filter by whether the enclosed check has been deposited.

CoworkerDelivery_Forwarded · boolean

Filter by whether the delivery has been forwarded to the customer.

CoworkerDelivery_Scanned · boolean

Filter by whether the delivery contents have been scanned.

CoworkerDelivery_Recycled · boolean

Filter by whether the delivery has been recycled.

CoworkerDelivery_Shredded · boolean

Filter by whether the delivery has been shredded.

CoworkerDelivery_StoredForCollection · boolean

Filter by whether the delivery is being held for customer collection.

CoworkerDelivery_ReturnedToSender · boolean

Filter by whether the delivery has been returned to sender.

CoworkerDelivery_CheckDepositedOn · string

Filter by date and time the check was deposited.

CoworkerDelivery_ForwardedOn · string

Filter by date and time the delivery was forwarded.

CoworkerDelivery_ScannedOn · string

Filter by date and time the delivery contents were scanned.

CoworkerDelivery_RecycledOn · string

Filter by date and time the delivery was recycled.

CoworkerDelivery_ShreddedOn · string

Filter by date and time the delivery was shredded.

CoworkerDelivery_StoredForCollectionOn · string

Filter by date and time the delivery was placed in storage for collection.

CoworkerDelivery_ReturnedToSenderOn · string

Filter by date and time the delivery was returned to sender.

CoworkerDelivery_ForwardingAddressUniqueId · string

Filter by Forwarding Address Unique Id.

CoworkerDelivery_CheckDepositedProductUniqueId · string

Filter by Check Deposited Product Unique Id.

CoworkerDelivery_ForwardedProductUniqueId · string

Filter by Forwarded Product Unique Id.

CoworkerDelivery_ScannedProductUniqueId · string

Filter by Scanned Product Unique Id.

CoworkerDelivery_RecycledProductUniqueId · string

Filter by Recycled Product Unique Id.

CoworkerDelivery_ShreddedProductUniqueId · string

Filter by Shredded Product Unique Id.

CoworkerDelivery_StoredForCollectionProductUniqueId · string

Filter by Stored For Collection Product Unique Id.

CoworkerDelivery_ReturnedToSenderProductUniqueId · string

Filter by Returned To Sender Product Unique Id.

CoworkerDelivery_CollectedProductUniqueId · string

Filter by Collected Product Unique Id.

Range Filters

from_CoworkerDelivery_CollectedOn · string

Filter by date and time the customer collected the delivery greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_CollectedOn · string

Filter by date and time the customer collected the delivery less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_CheckDepositedOn · string

Filter by date and time the check was deposited greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_CheckDepositedOn · string

Filter by date and time the check was deposited less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_ForwardedOn · string

Filter by date and time the delivery was forwarded greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_ForwardedOn · string

Filter by date and time the delivery was forwarded less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_ScannedOn · string

Filter by date and time the delivery contents were scanned greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_ScannedOn · string

Filter by date and time the delivery contents were scanned less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_RecycledOn · string

Filter by date and time the delivery was recycled greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_RecycledOn · string

Filter by date and time the delivery was recycled less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_ShreddedOn · string

Filter by date and time the delivery was shredded greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_ShreddedOn · string

Filter by date and time the delivery was shredded less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_StoredForCollectionOn · string

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.

to_CoworkerDelivery_StoredForCollectionOn · string

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.

from_CoworkerDelivery_ReturnedToSenderOn · string

Filter by date and time the delivery was returned to sender greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_ReturnedToSenderOn · string

Filter by date and time the delivery was returned to sender less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CoworkerDelivery_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CoworkerDelivery_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkerdeliveries?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkerdeliveries?CoworkerDelivery_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

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"

Response

200

Records · CoworkerDelivery[]

The list of CoworkerDelivery records matching the query. See the Get one CoworkerDelivery 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 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.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "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": "[e-mail]",
      "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
}