> ## 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.

# Get one CoworkerDataFile

> Retrieve a single CoworkerDataFile record by its Id.

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-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CoworkerDataFile record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/spaces/coworkerdatafiles/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/coworkerdatafiles/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  Location ID.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the customer this file belongs to.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the customer.
</ResponseField>

<ResponseField name="CoworkerCoworkerType" type="string">
  Record type of the customer (Individual or Company).
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the customer.
</ResponseField>

<ResponseField name="CoworkerBillingName" type="string">
  Billing name of the customer.
</ResponseField>

<ResponseField name="Name" type="string">
  Name of the file or document.
</ResponseField>

<ResponseField name="Description" type="string">
  Notes included in the email notification sent to the customer when the file is shared.
</ResponseField>

<ResponseField name="AvailableToUser" type="boolean">
  Whether the file is shared with the customer and visible on the Members Portal.
</ResponseField>

<ResponseField name="RequestDigitalSignature" type="boolean">
  Whether to request a digital signature from the customer.
</ResponseField>

<ResponseField name="FileDataFileName" type="string">
  Name of the uploaded file.
</ResponseField>

<ResponseField name="NewFileDataUrl" type="string">
  URL of a new file to upload (replaces the existing file).
</ResponseField>

<ResponseField name="ClearFileDataFile" type="boolean">
  Set to true to remove the existing uploaded file.
</ResponseField>

<ResponseField name="SignedFileDataFileName" type="string">
  Name of the signed copy of the document, created automatically after the customer signs it.
</ResponseField>

<ResponseField name="NewSignedFileDataUrl" type="string">
  URL of a new signed file to upload (replaces the existing signed copy).
</ResponseField>

<ResponseField name="ClearSignedFileDataFile" type="boolean">
  Set to true to remove the existing signed copy.
</ResponseField>

<ResponseField name="Extension" type="string">
  File extension (e.g. pdf, docx, jpg).
</ResponseField>

<ResponseField name="Billed" type="boolean">
  Whether the customer has been billed for this file.
</ResponseField>

<ResponseField name="Signed" type="boolean">
  Whether the customer has signed this document.
</ResponseField>

<ResponseField name="EsignIdentifier" type="string">
  Identifier used by the digital signature provider to track this document.
</ResponseField>

<ResponseField name="DocumentTemplateGuid" type="string">
  GUID of the document template used to generate this file.
</ResponseField>

<ResponseField name="NotifyWhenSignedEmail" type="string">
  Email address to notify when the customer signs the document.
</ResponseField>

<ResponseField name="ProposalGuid" type="string">
  GUID of the proposal linked to this file.
</ResponseField>

<ResponseField name="CoworkerContractGuid" type="string">
  GUID of the coworker contract linked to this file.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "CoworkerCoworkerType": null,
  "CoworkerCompanyName": null,
  "CoworkerBillingName": null,
  "Name": "",
  "Description": null,
  "AvailableToUser": false,
  "RequestDigitalSignature": false,
  "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
}
```