Get one CoworkerDelivery

GET

api

spaces

coworkerdeliveries

{id}

Get one CoworkerDelivery

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkerdeliveries/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkerdeliveries/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "ContractContactId": 123,
  "ContractContactFullName": "<string>",
  "ContractContactEmail": "<string>",
  "Name": "<string>",
  "Location": "<string>",
  "ReceivedBy": "<string>",
  "Notes": "<string>",
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": true,
  "SignatureFileName": "<string>",
  "NewSignatureUrl": "<string>",
  "ClearSignatureFile": true,
  "ScannedFileDataFileName": "<string>",
  "NewScannedFileDataUrl": "<string>",
  "ClearScannedFileDataFile": true,
  "ForwardedFileDataFileName": "<string>",
  "NewForwardedFileDataUrl": "<string>",
  "ClearForwardedFileDataFile": true,
  "Processed": true,
  "Collected": true,
  "RequiresSignature": true,
  "Signed": true,
  "Notified": true,
  "CollectedOn": "<string>",
  "Billed": true,
  "DeliveryType": 123,
  "HandlingPreference": 123,
  "CheckDeposited": true,
  "Forwarded": true,
  "Scanned": true,
  "Recycled": true,
  "Shredded": true,
  "StoredForCollection": true,
  "ReturnedToSender": true,
  "CheckDepositedOn": "<string>",
  "ForwardedOn": "<string>",
  "ScannedOn": "<string>",
  "RecycledOn": "<string>",
  "ShreddedOn": "<string>",
  "StoredForCollectionOn": "<string>",
  "ReturnedToSenderOn": "<string>",
  "ForwardingAddressUniqueId": "<string>",
  "CheckDepositedProductUniqueId": "<string>",
  "ForwardedProductUniqueId": "<string>",
  "ScannedProductUniqueId": "<string>",
  "RecycledProductUniqueId": "<string>",
  "ShreddedProductUniqueId": "<string>",
  "StoredForCollectionProductUniqueId": "<string>",
  "ReturnedToSenderProductUniqueId": "<string>",
  "CollectedProductUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the CoworkerDelivery record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkerdeliveries/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

integer

ID of the coworker linked to this record.

string

The coworker coworker type value for this coworker delivery.

string

Full name of the customer the delivery is for.

string

Email address of the customer the delivery is for.

string

Billing name of the customer the delivery is for.

string

Company name of the customer the delivery is for.

string

Team names the customer belongs to.

integer

ID of the contract contact linked to this record.

string

Full name of the contract contact the delivery is for.

string

Email address of the contract contact the delivery is for.

string

Short label or description identifying the delivery item.

string

Physical location where the delivery is being stored (e.g. mailroom shelf).

string

Name of the staff member who received the delivery.

string

Free-text notes about the delivery.

string

Current file name of the file data (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the file data.

boolean

Set to true to remove the current file data file.

string

Current file name of the signature (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the signature.

boolean

Set to true to remove the current signature file.

string

Current file name of the scanned file data (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the scanned file data.

boolean

Set to true to remove the current scanned file data file.

string

Current file name of the forwarded file data (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the forwarded file data.

boolean

Set to true to remove the current forwarded file data file.

boolean

Whether the delivery has been processed according to the handling preference.

boolean

Whether the customer has collected the delivery.

boolean

Whether the customer must sign upon collection.

boolean

Whether the customer has signed for the delivery.

boolean

Whether notified is enabled.

string

Date and time the customer collected the delivery.

boolean

Whether billed is enabled.

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.

integer

How the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred).

boolean

Whether the enclosed check has been deposited.

boolean

Whether the delivery has been forwarded to the customer.

boolean

Whether the delivery contents have been scanned.

boolean

Whether the delivery has been recycled.

boolean

Whether the delivery has been shredded.

boolean

Whether the delivery is being held for customer collection.

boolean

Whether the delivery has been returned to sender.

string

Date and time the check was deposited.

string

Date and time the delivery was forwarded.

string

Date and time the delivery contents were scanned.

string

Date and time the delivery was recycled.

string

Date and time the delivery was shredded.

string

Date and time the delivery was placed in storage for collection.

string

Date and time the delivery was returned to sender.

string

ID of the forwarding address unique associated with this record.

string

ID of the check deposited product unique associated with this record.

string

ID of the forwarded product unique associated with this record.

string

ID of the scanned product unique associated with this record.

string

ID of the recycled product unique associated with this record.

string

ID of the shredded product unique associated with this record.

string

ID of the stored for collection product unique associated with this record.

string

ID of the returned to sender product unique associated with this record.

string

ID of the collected product unique associated with this record.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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
}

Get multiple CoworkerDeliveriesRetrieve multiple CoworkerDelivery records by their Ids in a single request.

Get one CoworkerDelivery

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkerdeliveries/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/coworkerdeliveries/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "ContractContactId": 123,
  "ContractContactFullName": "<string>",
  "ContractContactEmail": "<string>",
  "Name": "<string>",
  "Location": "<string>",
  "ReceivedBy": "<string>",
  "Notes": "<string>",
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": true,
  "SignatureFileName": "<string>",
  "NewSignatureUrl": "<string>",
  "ClearSignatureFile": true,
  "ScannedFileDataFileName": "<string>",
  "NewScannedFileDataUrl": "<string>",
  "ClearScannedFileDataFile": true,
  "ForwardedFileDataFileName": "<string>",
  "NewForwardedFileDataUrl": "<string>",
  "ClearForwardedFileDataFile": true,
  "Processed": true,
  "Collected": true,
  "RequiresSignature": true,
  "Signed": true,
  "Notified": true,
  "CollectedOn": "<string>",
  "Billed": true,
  "DeliveryType": 123,
  "HandlingPreference": 123,
  "CheckDeposited": true,
  "Forwarded": true,
  "Scanned": true,
  "Recycled": true,
  "Shredded": true,
  "StoredForCollection": true,
  "ReturnedToSender": true,
  "CheckDepositedOn": "<string>",
  "ForwardedOn": "<string>",
  "ScannedOn": "<string>",
  "RecycledOn": "<string>",
  "ShreddedOn": "<string>",
  "StoredForCollectionOn": "<string>",
  "ReturnedToSenderOn": "<string>",
  "ForwardingAddressUniqueId": "<string>",
  "CheckDepositedProductUniqueId": "<string>",
  "ForwardedProductUniqueId": "<string>",
  "ScannedProductUniqueId": "<string>",
  "RecycledProductUniqueId": "<string>",
  "ShreddedProductUniqueId": "<string>",
  "StoredForCollectionProductUniqueId": "<string>",
  "ReturnedToSenderProductUniqueId": "<string>",
  "CollectedProductUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200