API Reference

List uploads

get
https://api.fanheroapi.com/uploads
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns a paginated list of Uploads for a channel. Pass the channel ID in the channel header.

To filter the output, use the query parameters.

📘

Note that filename filter can be a partial match.

Header parameters organization is required for authentication.

Query Params
number

Number of documents that will be returned

number

Page to search. Page numbering starts with 0.

string

Controls the sorting. Format: <field_name>.<asc|desc> (asc for ascending order, desc for descending order). If no order specified it will be in descending order.

boolean

Set this to True to retrieve only the uploads that have expired. Set to False to retrieve only the ones that are not expired.

string

Filter by account ID. The entire ID must match.

string

Filter by file name. This can ba a partial match.

Headers
string
required

Channel ID

string
required

The URL of the end-user web application

Response

Updated about 1 year ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?