Lists all (or one) files.

Endpoint URL

https://dashboard-api.revnue.com/api/v2/file

Authentication and rate limits

Item

Detail

Authentication method

OAuth 2.0 Bearer token

Rate limit

Rate Limit

Requests Example

curl --request GET \
  --url 'https://dashboard-api.revnue.com/api/v2/file/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'
curl --request GET \
  --url 'https://dashboard-api.revnue.com/api/v2/file/?company=1&file=$id' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

Query Parameters

  • company (integer) --

    [REQUIRED]
    The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
    To lookup a specific company ID, see the List Company API.

  • file (integer) --

    Optional if you want to list a specific file ID. The file parameter is passed as part of the request url &file=$id.

Response Syntax

{
  "id": integer,
  "filename": "string",
  "file_size": integer,
  "upload_date": "string",
  "uploaded_by": "string",
  "repository": "string",
  "upload_source": "string"
}

Response Fields

  • id (integer) --

    The ID of the file.

  • filename (string) --

    The name of the file.

  • file_size (integer) --

    The size of the file in bytes.

  • uploaded_date (string) --

    The date the file was uploaded.

  • uploaded_by (string) --

    The user who uploaded the file.

  • repository (string) --

    The repository location of the file.

  • uploaded_source (string) --

    The upload source of the file.