Help Search

Edit on github

Browse all Folders

To fetch a given folder the user has access to, one need to make the following request:

GET /folders/<foldersUuid>.json

Request Parameters

The endpoint takes the following parameters

Param Description Required Type
contain[children_resources] Whether or not to include the resources included in the folder (direct children only) No Boolean
contain[children_folders] Whether or not to include the folders included in the folder (direct children only) No Boolean
contain[creator] Whether or not to include the folder creator user record No Boolean
contain[creator.profile] Whether or not to include the folder creator profile No Boolean
contain[modifier] Whether or not to include the modifier user record No Boolean
contain[modifier.profile] Whether or not to include the modifier profile No Boolean
contain[permission] Whether or not to include the permission for the current user for this folder No Boolean
contain[permissions] Whether or not to include the all the permissions for this folder No Boolean
contain[permissions.user.profile] Whether or not to include the user profile associated with the permissions No Boolean
contain[permissions.group] Whether or not to include the group details with the permissions No Boolean

Possible responses

Code Description
200 OK
Request went through. The response payload will contain a list of folders.
400 Bad Request
If one parameter or more are invalid.
403 Authentication Failure
The user making the request is not authenticated.
404 Not found
The folder does not exist

Examples

Filtered request

Here is an example of request, to also fetch the children resources and folders and display the current user permission:

GET /folders/9e03fd73-04c0-5514-95fa-1a6cf2c7c093.json
    ?contain[children_folders]=1
    &contain[children_resources]=1
    &contain[permission]=1

Success response

A successful response will return a object representing the folder and the associated data. It will look something like this, the previously mentioned request:

{
    "header": {
        "id": "bf15a987-2588-4b6f-8d7f-6e1f695fc09e",
        "status": "success",
        "servertime": 1619795346,
        "action": "ab13b3e0-eae8-5099-909f-8582a3c2ddae",
        "message": "The operation was successful.",
        "url": "\/folders\/9e03fd73-04c0-5514-95fa-1a6cf2c7c093.json?contain%5Bchildren_folders%5D=1\u0026contain%5Bchildren_resources%5D=1\u0026contain%5Bpermission%5D=1",
        "code": 200
    },
    "body": {
        "id": "9e03fd73-04c0-5514-95fa-1a6cf2c7c093",
        "name": "Accounting",
        "created": "2020-02-01T00:00:00+00:00",
        "modified": "2020-02-01T00:00:00+00:00",
        "created_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
        "modified_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
        "children_resources": [],
        "children_folders": [
            {
                "id": "6592f71b-8874-5e91-bf6d-829b8ad188f5",
                "name": "Bank",
                "created": "2020-02-01T00:00:00+00:00",
                "modified": "2020-02-01T00:00:00+00:00",
                "created_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
                "modified_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
                "folder_parent_id": "9e03fd73-04c0-5514-95fa-1a6cf2c7c093",
                "personal": false
            },
            {
                "id": "1ccd70c8-14dc-59ec-9c06-60ce613c6f1d",
                "name": "VAT",
                "created": "2020-02-01T00:00:00+00:00",
                "modified": "2020-02-01T00:00:00+00:00",
                "created_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
                "modified_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
                "folder_parent_id": "9e03fd73-04c0-5514-95fa-1a6cf2c7c093",
                "personal": false
            },
            {
                "id": "a5f0d94d-0fa3-5d82-9800-dda68820ec7c",
                "name": "Credit Cards",
                "created": "2020-02-01T00:00:00+00:00",
                "modified": "2020-02-01T00:00:00+00:00",
                "created_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
                "modified_by": "d57c10f5-639d-5160-9c81-8a0c6c4ec856",
                "folder_parent_id": "9e03fd73-04c0-5514-95fa-1a6cf2c7c093",
                "personal": false
            }
        ],
        "permission": {
            "id": "6aada140-fe8b-5e69-a90f-ae0cec6d3dcf",
            "aco": "Folder",
            "aco_foreign_key": "9e03fd73-04c0-5514-95fa-1a6cf2c7c093",
            "aro": "User",
            "aro_foreign_key": "f848277c-5398-58f8-a82a-72397af2d450",
            "type": 1,
            "created": "2021-04-30T05:36:58+00:00",
            "modified": "2021-04-30T05:36:58+00:00"
        },
        "folder_parent_id": null,
        "personal": false
    }
}

Last updated

This article was last updated on April 29th, 2021.

For another perspective on the API you browse the OpenAPI 2.0 specifications using the dedicated API reference site (Swagger UI).

API Reference

You can also find the latest OpenAPI 2.0 specifications directly on the dedicated repository.

OpenAPI Specs repository