GET /api/account/file-folders

get/api/account/file-folders

Example request

GET https://api.jupiter-erp.com/api/account/file-folders

Code

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

Parameters

Name	In	Required	Description
parent_id	query	no	Filter by parent folder ID
order_by	query	no	Sort by a specific field
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Responses

200OK

ModelListFileFolders200Response

Field

Type

Description

data*

object[]

array

Elements

Field	Type	Description
child_folders_count*	integer	—
created_at	string (date-time)	Creation timestamp in ISO 8601 format.
files_count*	integer	—
hex_color	string	—
id*	integer	—
name*	string	—
parent_id	integer	—
protected	boolean	—
updated_at	string (date-time)	Last update timestamp in ISO 8601 format.

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,
      "parent_id": 0,
      "name": "string",
      "protected": true,
      "hex_color": "string",
      "files_count": 0,
      "child_folders_count": 0
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}

FileFolders

Questions about integration?