List Files
Intent
Reads the available files as a pageable collection without changing them.
When to call it
Call this when an interface, sync, or support workflow needs to inspect files. Use the filters and paging controls shown below to limit the result.
Access boundary
Authorize the request with a token that carries files:read or files:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Query Parameters
Return only records matching organization ID. Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Return only records matching file ID.
Results page to return. The first page is used by default.
Records returned per page. Defaults to 10 and accepts up to 100.
Response
Request completed successfully
File to be associated with the downloadables benefit.
- DownloadableFileRead
- ProductMediaFileRead
- SupportCaseAttachmentFileRead