Get one CoworkerDataFile

GET

api

spaces

coworkerdatafiles

{id}

Get one CoworkerDataFile

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

import requests

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

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "AvailableToUser": true,
  "RequestDigitalSignature": true,
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": true,
  "SignedFileDataFileName": "<string>",
  "NewSignedFileDataUrl": "<string>",
  "ClearSignedFileDataFile": true,
  "Extension": "<string>",
  "Billed": true,
  "Signed": true,
  "EsignIdentifier": "<string>",
  "DocumentTemplateGuid": "<string>",
  "NotifyWhenSignedEmail": "<string>",
  "ProposalGuid": "<string>",
  "CoworkerContractGuid": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the CoworkerDataFile record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkerdatafiles/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

Location ID.

string

Location name.

integer

ID of the customer this file belongs to.

string

Full name of the customer.

string

Record type of the customer (Individual or Company).

string

Company name of the customer.

string

Billing name of the customer.

string

Name of the file or document.

string

Notes included in the email notification sent to the customer when the file is shared.

boolean

Whether the file is shared with the customer and visible on the Members Portal.

boolean

Whether to request a digital signature from the customer.

string

Name of the uploaded file.

string

URL of a new file to upload (replaces the existing file).

boolean

Set to true to remove the existing uploaded file.

string

Name of the signed copy of the document, created automatically after the customer signs it.

string

URL of a new signed file to upload (replaces the existing signed copy).

boolean

Set to true to remove the existing signed copy.

string

File extension (e.g. pdf, docx, jpg).

boolean

Whether the customer has been billed for this file.

boolean

Whether the customer has signed this document.

string

Identifier used by the digital signature provider to track this document.

string

GUID of the document template used to generate this file.

string

Email address to notify when the customer signs the document.

string

GUID of the proposal linked to this file.

string

GUID of the coworker contract linked to this file.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

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

Get multiple CoworkerDataFilesRetrieve multiple CoworkerDataFile records by their Ids in a single request.

Get one CoworkerDataFile

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

import requests

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

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerBillingName": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "AvailableToUser": true,
  "RequestDigitalSignature": true,
  "FileDataFileName": "<string>",
  "NewFileDataUrl": "<string>",
  "ClearFileDataFile": true,
  "SignedFileDataFileName": "<string>",
  "NewSignedFileDataUrl": "<string>",
  "ClearSignedFileDataFile": true,
  "Extension": "<string>",
  "Billed": true,
  "Signed": true,
  "EsignIdentifier": "<string>",
  "DocumentTemplateGuid": "<string>",
  "NotifyWhenSignedEmail": "<string>",
  "ProposalGuid": "<string>",
  "CoworkerContractGuid": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200