> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search CoworkerDataFiles

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

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

<Note>
  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.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="CoworkerDataFile_Business" type="integer">
  Filter by location ID.
</ParamField>

<ParamField query="CoworkerDataFile_Business_Name" type="string">
  Filter by location name.
</ParamField>

<ParamField query="CoworkerDataFile_Coworker" type="integer">
  Filter by iD of the customer this file belongs to.
</ParamField>

<ParamField query="CoworkerDataFile_Coworker_FullName" type="string">
  Filter by full name of the customer.
</ParamField>

<ParamField query="CoworkerDataFile_Coworker_CoworkerType" type="string">
  Filter by record type of the customer (Individual or Company).
</ParamField>

<ParamField query="CoworkerDataFile_Coworker_CompanyName" type="string">
  Filter by company name of the customer.
</ParamField>

<ParamField query="CoworkerDataFile_Coworker_BillingName" type="string">
  Filter by billing name of the customer.
</ParamField>

<ParamField query="CoworkerDataFile_Name" type="string">
  Filter by name of the file or document.
</ParamField>

<ParamField query="CoworkerDataFile_Description" type="string">
  Filter by notes included in the email notification sent to the customer when the file is shared.
</ParamField>

<ParamField query="CoworkerDataFile_AvailableToUser" type="boolean">
  Filter by whether the file is shared with the customer and visible on the Members Portal.
</ParamField>

<ParamField query="CoworkerDataFile_RequestDigitalSignature" type="boolean">
  Filter by whether to request a digital signature from the customer.
</ParamField>

<ParamField query="CoworkerDataFile_FileDataFileName" type="string">
  Filter by name of the uploaded file.
</ParamField>

<ParamField query="CoworkerDataFile_NewFileDataUrl" type="string">
  Filter by uRL of a new file to upload (replaces the existing file).
</ParamField>

<ParamField query="CoworkerDataFile_ClearFileData" type="boolean">
  Filter by set to true to remove the existing uploaded file.
</ParamField>

<ParamField query="CoworkerDataFile_SignedFileDataFileName" type="string">
  Filter by name of the signed copy of the document, created automatically after the customer signs it.
</ParamField>

<ParamField query="CoworkerDataFile_NewSignedFileDataUrl" type="string">
  Filter by uRL of a new signed file to upload (replaces the existing signed copy).
</ParamField>

<ParamField query="CoworkerDataFile_ClearSignedFileData" type="boolean">
  Filter by set to true to remove the existing signed copy.
</ParamField>

<ParamField query="CoworkerDataFile_Extension" type="string">
  Filter by file extension (e.g. pdf, docx, jpg).
</ParamField>

<ParamField query="CoworkerDataFile_Billed" type="boolean">
  Filter by whether the customer has been billed for this file.
</ParamField>

<ParamField query="CoworkerDataFile_Signed" type="boolean">
  Filter by whether the customer has signed this document.
</ParamField>

<ParamField query="CoworkerDataFile_EsignIdentifier" type="string">
  Filter by identifier used by the digital signature provider to track this document.
</ParamField>

<ParamField query="CoworkerDataFile_DocumentTemplateGuid" type="string">
  Filter by gUID of the document template used to generate this file.
</ParamField>

<ParamField query="CoworkerDataFile_NotifyWhenSignedEmail" type="string">
  Filter by email address to notify when the customer signs the document.
</ParamField>

<ParamField query="CoworkerDataFile_ProposalGuid" type="string">
  Filter by gUID of the proposal linked to this file.
</ParamField>

<ParamField query="CoworkerDataFile_CoworkerContractGuid" type="string">
  Filter by gUID of the coworker contract linked to this file.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerDataFile_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerDataFile_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerDataFile_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerDataFile_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkerdatafiles?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkerdatafiles?CoworkerDataFile_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerDataFile[]">
  The list of CoworkerDataFile records matching the query. See the [Get one CoworkerDataFile](/rest-api/spaces/get-coworkerdatafiles-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **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](/rest-api/spaces/get-coworkerdatafiles-by-id) 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.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```