Jupiter ERP

get/api/account/files

Example request

GET https://api.jupiter-erp.com/api/account/files

Code

curl -X GET 'https://api.jupiter-erp.com/api/account/files' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json'

Parameters

Name	In	Required	Description
folder_id	query	no	Filter by folder ID
inbox	query	no	Selects only inbox files
trash	query	no	Selects only deleted files
category	query	no	Supports SQL-like syntax: - `test`: begins with `test` - `test`: ends with `test` - `test`: contains `test` - `test`: exact match.
date_from	query	no	Search from date
date_to	query	no	Search to date
contact_id	query	no	Filter by contact ID
file_name	query	no	Supports SQL-like syntax: - `test`: begins with `test` - `test`: ends with `test` - `test`: contains `test` - `test`: exact match.
created_user_id	query	no	Filter by user ID
created_at_from	query	no	Search from created_at
created_at_to	query	no	Search to created_at
order_by	query	no	Sort by a specific field
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Responses

200OK

ModelListFiles200Response

Field

Type

Description

data*

object[]

array

Elements

Field

Type

Description

category

string

—

contact

object

Field

Type

Description

avatar

object

Field	Type	Description
url	string	—

name

string

—

contact_id

integer

—

created_at

string (date-time)

Creation timestamp in ISO 8601 format.

created_by

object

Field	Type	Description
image_url	string	—
name	string	—

created_user_id

integer

—

date

string

—

deleted_at

string (date-time)

Creation timestamp in ISO 8601 format.

file_bytes

integer

—

file_ext

string

—

file_name*

string

—

file_type

string

—

folder

object

Field	Type	Description
name*	string	—
path	string	Full folder path from root to the file's folder (parent segments joined with " / ").

folder_id

integer

—

id*

integer

—

is_xml

boolean

—

new

boolean

—

notes

string

—

owner_entity_id

integer

ID of the owner entity within the account.

owner_entity_label

string

Cached display label of the linked owner entity (e.g. invoice number).

owner_entity_type

string

API entity type of the owner (e.g. Invoice, Receipt).

protected

boolean

—

reference_number

string

—

scanned_at

string

—

thumbnail_url

string

—

updated_at

string (date-time)

Last update timestamp in ISO 8601 format.

url

string

—

meta*

object

Field	Type	Description
current_page*	integer	The current page number.
items_from*	integer	The starting item number on the current page.
items_to*	integer	The ending item number on the current page.
last_page*	integer	The last page number.
per_page*	integer	The number of items per page.
total*	integer	The total number of items.

Example response

{
  "data": [
    {
      "id": 0,
      "category": "string",
      "date": "string",
      "reference_number": "string",
      "protected": true,
      "new": true,
      "file_name": "string"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}

Files

Questions about integration?