Search CoworkerDeliveries

GET

api

spaces

coworkerdeliveries

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

A delivery records mail, parcels, checks, publicity, or other items received at a location for a customer or contract contact. For ordinary customers, track collection only; for virtual-office customers, the handling preference selects a processing sequence and its completed lifecycle steps.

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
1	Mail
2	Parcel
3	Check
4	Publicity
5	Other

eDeliveryHandlingPreference

Value	Name
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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location that owns this delivery. Defaults to the current location when creating a delivery..

integer

Filter by iD of the customer this delivery is for. Use either CoworkerId or ContractContactId to identify the recipient..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.Email..

string

Filter by display value for Coworker.BillingName..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.TeamNames..

integer

Filter by iD of the contract contact receiving this delivery when it is not assigned to a customer..

string

Filter by display value for ContractContact.FullName..

string

Filter by display value for ContractContact.Email..

string

Filter by required short reference that identifies the delivery item..

string

Filter by required physical storage location for the delivery, such as a mailroom shelf..

string

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

string

Filter by free-text operational notes about the delivery..

string

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

string

Filter by uRL of a new file to upload as the file data.

boolean

Filter by set to true to remove the current file data file.

string

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

string

Filter by uRL of a new file to upload as the signature.

boolean

Filter by set to true to remove the current signature file.

string

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

string

Filter by uRL of a new file to upload as the scanned file data.

boolean

Filter by set to true to remove the current scanned file data file.

string

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

string

Filter by uRL of a new file to upload as the forwarded file data.

boolean

Filter by set to true to remove the current forwarded file data file.

boolean

Filter by whether all required virtual-office handling steps have been completed; it is calculated from the selected HandlingPreference and is not relevant for ordinary customer deliveries..

boolean

Filter by whether the customer has collected the delivery; set CollectedOn when recording collection..

boolean

Filter by whether the customer must provide a signature when collecting the delivery..

boolean

Filter by whether the customer has signed for the delivery; attach the signature through NewSignatureUrl when available..

boolean

Filter by whether the system sent the delivery-received notification; maintained by delivery notification handlers..

string

Filter by date and time the customer collected the delivery; record it when marking Collected as true..

boolean

Filter by whether charges for delivery handling have been billed; maintained by the delivery processing workflow..

integer

Filter by type of delivery item: Mail, Parcel, Check, Publicity, or Other. It selects the default handling preference for virtual-office customers..

integer

Filter by virtual-office delivery workflow: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown. It is not relevant for customers without a virtual-office contract; for virtual-office customers it defaults from the active contract by delivery type, falling back to StoreForCollection..

boolean

Filter by for a virtual-office DepositCheck workflow, whether the enclosed check has been deposited; record CheckDepositedOn when marking it complete..

boolean

Filter by for a virtual-office forwarding workflow, whether the delivery has been forwarded to the customer; record ForwardedOn when marking it complete..

boolean

Filter by for a virtual-office open-and-scan workflow, whether the delivery contents have been scanned; record ScannedOn when marking it complete..

boolean

Filter by for a virtual-office recycling workflow, whether the delivery has been recycled; record RecycledOn when marking it complete..

boolean

Filter by for a virtual-office shredding workflow, whether the delivery has been shredded; record ShreddedOn when marking it complete..

boolean

Filter by for a virtual-office collection workflow, whether the delivery has been stored for customer collection; record StoredForCollectionOn when marking it complete..

boolean

Filter by for a virtual-office return workflow, whether the delivery has been returned to the sender; record ReturnedToSenderOn when marking it complete..

string

Filter by for a virtual-office DepositCheck workflow, date and time the check was deposited, recorded with CheckDeposited..

string

Filter by for a virtual-office forwarding workflow, date and time the delivery was forwarded, recorded with Forwarded..

string

Filter by for a virtual-office open-and-scan workflow, date and time the delivery contents were scanned, recorded with Scanned..

string

Filter by for a virtual-office recycling workflow, date and time the delivery was recycled, recorded with Recycled..

string

Filter by for a virtual-office shredding workflow, date and time the delivery was shredded, recorded with Shredded..

string

Filter by for a virtual-office collection workflow, date and time the delivery was placed in storage for collection, recorded with StoredForCollection..

string

Filter by for a virtual-office return workflow, date and time the delivery was returned to the sender, recorded with ReturnedToSender..

string

Filter by unique ID of the nominated forwarding address; defaults from the virtual-office contract and is managed by the delivery workflow..

string

Filter by unique ID of the product charge created for depositing a check; managed by the delivery workflow..

string

Filter by unique ID of the product charge created for forwarding; managed by the delivery workflow..

string

Filter by unique ID of the product charge created for scanning; managed by the delivery workflow..

string

Filter by unique ID of the product charge created for recycling; managed by the delivery workflow..

string

Filter by unique ID of the product charge created for shredding; managed by the delivery workflow..

string

Filter by unique ID of the product charge created for storage for collection; managed by the delivery workflow..

string

Filter by unique ID of the product charge created for returning to sender; managed by the delivery workflow..

string

Filter by unique ID of the product charge created for collection; managed by the delivery workflow..

Range Filters

string

Filter by date and time the customer collected the delivery; record it when marking Collected as true. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date and time the customer collected the delivery; record it when marking Collected as true. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office DepositCheck workflow, date and time the check was deposited, recorded with CheckDeposited. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office DepositCheck workflow, date and time the check was deposited, recorded with CheckDeposited. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office forwarding workflow, date and time the delivery was forwarded, recorded with Forwarded. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office forwarding workflow, date and time the delivery was forwarded, recorded with Forwarded. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office open-and-scan workflow, date and time the delivery contents were scanned, recorded with Scanned. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office open-and-scan workflow, date and time the delivery contents were scanned, recorded with Scanned. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office recycling workflow, date and time the delivery was recycled, recorded with Recycled. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office recycling workflow, date and time the delivery was recycled, recorded with Recycled. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office shredding workflow, date and time the delivery was shredded, recorded with Shredded. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office shredding workflow, date and time the delivery was shredded, recorded with Shredded. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office collection workflow, date and time the delivery was placed in storage for collection, recorded with StoredForCollection. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office collection workflow, date and time the delivery was placed in storage for collection, recorded with StoredForCollection. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office return workflow, date and time the delivery was returned to the sender, recorded with ReturnedToSender. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by for a virtual-office return workflow, date and time the delivery was returned to the sender, recorded with ReturnedToSender. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

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

string

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

string

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

string

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

Code Examples

Simple listing

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

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();

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

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

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();

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

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"

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();

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

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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

Search CoworkerDeliveries

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200