Search CoworkerDataFiles

GET

api

spaces

coworkerdatafiles

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

import requests

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

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/coworkerdatafiles', 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 customer file is a document attached to a customer’s record that can remain internal, be shared through the Members Portal, or be sent for digital signature.

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 CoworkerDataFile-List role.

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 this customer file belongs to; it is supplied from the admin context when creating the record..

string

Filter by display value for Business.Name..

integer

Filter by iD of the customer this file belongs to..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.BillingName..

string

Filter by required name displayed for the customer file or document..

string

Filter by optional notes for the customer file; included in the notification sent when a new file is shared or sent for signature..

boolean

Filter by whether the customer can view and download the file in the Members Portal; creating a shared file sends the new-file notification..

boolean

Filter by whether to request a digital signature from the customer; requires a portal-enabled customer, enabled Dropbox Sign integration, and valid signatories..

string

Filter by name of the uploaded file.

string

Filter by uRL of a new file to upload (replaces the existing file).

boolean

Filter by set to true to remove the existing uploaded file.

string

Filter by name of the signed copy of the document, created automatically after the customer signs it.

string

Filter by uRL of a new signed file to upload (replaces the existing signed copy).

boolean

Filter by set to true to remove the existing signed copy.

string

Filter by file extension for the stored document, such as .pdf, .docx, or .jpg..

boolean

Filter by whether the location has billed for this file’s digital signature request..

boolean

Filter by whether the customer has signed the document; this status is updated by the digital signature provider..

string

Filter by opaque identifier assigned by the digital signature provider to track this document; it is managed automatically..

string

Filter by unique ID of the document template used to generate the file; required when CoworkerContractGuid is set..

string

Filter by email address to notify after the customer signs; when omitted for a signature request, it defaults to the creating user’s email when available..

string

Filter by unique ID of the proposal this file supports; proposal workflows use it to locate their generated documents..

string

Filter by unique ID of the customer’s contract used to generate a contract document; requires DocumentTemplateGuid..

Range Filters

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/coworkerdatafiles?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkerdatafiles?' + 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/coworkerdatafiles',
    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/coworkerdatafiles?CoworkerDataFile_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkerdatafiles?' + new URLSearchParams({
    CoworkerDataFile_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/coworkerdatafiles',
    params={
        'CoworkerDataFile_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/coworkerdatafiles?from_CoworkerDataFile_UpdatedOn=2025-01-01T00:00&to_CoworkerDataFile_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkerdatafiles?' + new URLSearchParams({
    from_CoworkerDataFile_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerDataFile_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/coworkerdatafiles',
    params={
        'from_CoworkerDataFile_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerDataFile_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CoworkerDataFile[]

The list of CoworkerDataFile records matching the query. See the Get one CoworkerDataFile endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CoworkerDataFile. The following fields are not populated in the Records[] response: Description, AvailableToUser, RequestDigitalSignature.To get all fields, fetch the full record using the Get one CoworkerDataFile 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,
      "BusinessName": null,
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerCoworkerType": null,
      "CoworkerCompanyName": null,
      "CoworkerBillingName": null,
      "Name": "",
      "FileDataFileName": null,
      "NewFileDataUrl": null,
      "ClearFileDataFile": null,
      "SignedFileDataFileName": null,
      "NewSignedFileDataUrl": null,
      "ClearSignedFileDataFile": null,
      "Extension": null,
      "Billed": false,
      "Signed": false,
      "EsignIdentifier": null,
      "DocumentTemplateGuid": null,
      "NotifyWhenSignedEmail": null,
      "ProposalGuid": null,
      "CoworkerContractGuid": 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": "CoworkerDataFile 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 CoworkerDataFiles

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

import requests

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

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/coworkerdatafiles', 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

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200