Search CoworkerDataFiles

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

GET /api/spaces/coworkerdatafiles

Search CoworkerDataFiles

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/coworkerdatafiles \
  --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 CoworkerDataFile is a file attached to a customer’s record. Files can be kept internal or shared with the customer on the Members Portal.

When a file is shared (AvailableToUser = true), the customer receives an email notification and can view or download the file from the Files tab under My Activity on the Members Portal.

You can request a digital signature (RequestDigitalSignature = true) — once the customer signs the document, a signed copy is automatically stored in SignedFileDataFileName. The notes in Description are included in the email notification sent to the customer.

Supported formats include .pdf, .docx, .xlsx, .jpg, .png, and other common types (max 10 MB). Files can be linked to a document template, a proposal, or a coworker contract via the respective GUID fields.

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

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

CoworkerDataFile_Business · integer

Filter by location ID.

CoworkerDataFile_Business_Name · string

Filter by location name.

CoworkerDataFile_Coworker · integer

Filter by iD of the customer this file belongs to.

CoworkerDataFile_Coworker_FullName · string

Filter by full name of the customer.

CoworkerDataFile_Coworker_CoworkerType · string

Filter by record type of the customer (Individual or Company).

CoworkerDataFile_Coworker_CompanyName · string

Filter by company name of the customer.

CoworkerDataFile_Coworker_BillingName · string

Filter by billing name of the customer.

CoworkerDataFile_Name · string

Filter by name of the file or document.

CoworkerDataFile_Description · string

Filter by notes included in the email notification sent to the customer when the file is shared.

CoworkerDataFile_AvailableToUser · boolean

Filter by whether the file is shared with the customer and visible on the Members Portal.

CoworkerDataFile_RequestDigitalSignature · boolean

Filter by whether to request a digital signature from the customer.

CoworkerDataFile_FileDataFileName · string

Filter by name of the uploaded file.

CoworkerDataFile_NewFileDataUrl · string

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

CoworkerDataFile_ClearFileData · boolean

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

CoworkerDataFile_SignedFileDataFileName · string

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

CoworkerDataFile_NewSignedFileDataUrl · string

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

CoworkerDataFile_ClearSignedFileData · boolean

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

CoworkerDataFile_Extension · string

Filter by file extension (e.g. pdf, docx, jpg).

CoworkerDataFile_Billed · boolean

Filter by whether the customer has been billed for this file.

CoworkerDataFile_Signed · boolean

Filter by whether the customer has signed this document.

CoworkerDataFile_EsignIdentifier · string

Filter by identifier used by the digital signature provider to track this document.

CoworkerDataFile_DocumentTemplateGuid · string

Filter by gUID of the document template used to generate this file.

CoworkerDataFile_NotifyWhenSignedEmail · string

Filter by email address to notify when the customer signs the document.

CoworkerDataFile_ProposalGuid · string

Filter by gUID of the proposal linked to this file.

CoworkerDataFile_CoworkerContractGuid · string

Filter by gUID of the coworker contract linked to this file.

Range Filters

from_CoworkerDataFile_CreatedOn · string

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

to_CoworkerDataFile_CreatedOn · string

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

from_CoworkerDataFile_UpdatedOn · string

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

to_CoworkerDataFile_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/coworkerdatafiles?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/coworkerdatafiles?CoworkerDataFile_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

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"

Response

200

Records · 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.

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