CoworkerDataFiles
Search CoworkerDataFiles
Search and list CoworkerDataFile records with filtering, sorting, and pagination.
GET
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
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by location ID.
Filter by location name.
Filter by iD of the customer this file belongs to.
Filter by full name of the customer.
Filter by record type of the customer (Individual or Company).
Filter by company name of the customer.
Filter by billing name of the customer.
Filter by name of the file or document.
Filter by notes included in the email notification sent to the customer when the file is shared.
Filter by whether the file is shared with the customer and visible on the Members Portal.
Filter by whether to request a digital signature from the customer.
Filter by name of the uploaded file.
Filter by uRL of a new file to upload (replaces the existing file).
Filter by set to true to remove the existing uploaded file.
Filter by name of the signed copy of the document, created automatically after the customer signs it.
Filter by uRL of a new signed file to upload (replaces the existing signed copy).
Filter by set to true to remove the existing signed copy.
Filter by file extension (e.g. pdf, docx, jpg).
Filter by whether the customer has been billed for this file.
Filter by whether the customer has signed this document.
Filter by identifier used by the digital signature provider to track this document.
Filter by gUID of the document template used to generate this file.
Filter by email address to notify when the customer signs the document.
Filter by gUID of the proposal linked to this file.
Filter by gUID of the coworker contract linked to this file.
Range Filters
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of CoworkerDataFile records matching the query. See the Get one CoworkerDataFile endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response