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

ID of the location this customer file belongs to; it is supplied from the admin context when creating the record..

string

Display value for Business.Name..

integer

ID of the customer this file belongs to..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.BillingName..

string

Required name displayed for the customer file or document..

string

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

boolean

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

boolean

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

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 for the stored document, such as .pdf, .docx, or .jpg..

boolean

Whether the location has billed for this file’s digital signature request..

boolean

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

string

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

string

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

string

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

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

string

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

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