API Data Provider - Online Help

Files

Retrieve a list of all files.

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

IsPublic Boolean False

FileName String False

FileSize Integer True

Category String True

ContactId Integer False

CreatedBy Integer True

DownloadUrl String True

FileData String False

FileBoxType String False

RemoteFileKey String True

DateCreated Datetime True

LastUpdated Datetime True

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Viewable String

Include public or private files in response (PUBLIC or PRIVATE), defaults to BOTH.

The allowed values are PUBLIC, PRIVATE.

Permission String

Filter based on the permission of files (USER or COMPANY), defaults to BOTH.

The allowed values are USER, COMPANY.

Type String

Filter based on the type of file.

The allowed values are Application, Image, Fax, Attachment, Ticket, Contact, DigitalProduct, Import, Hidden, WebForm, StyledCart, ReSampledImage, TemplateThumbnail, Funnel, LogoThumbnail, Unlayer, BrandingCenterLogo.

Name String

Filter files based on name, with '*' preceding or following to indicate LIKE queries.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0