folders list
GET {{baseUrl}}/folders
Returns a list of Folder
objects.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
summary | string | If provided, will only return folders in this drive. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
name | string | If provided, will only return folders with this name. | |
page_size | number | Number of results to return per page. | |
summary | string | If provided, will only return folders in this parent folder. If null, will return folders in root directory. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"fb2653b6-fa48-25aa-ae6c-26b0dcedc39c","remote_id":"14","name":"Platform","folder_url":"https://drive.com/1234","size":2738000,"description":"This is a wild folder.","parent_folder":"8aa9c1df-84df-077f-f16f-adbde09236a8","drive":"urn:uuid:f871c641-b903-5f04-c4b3-f10b633bd476","remote_created_at":"1953-11-16T01:19:21.031Z","remote_updated_at":"1975-12-02T19:41:50.246Z","field_mappings":{"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},"remote_data":[{"aliqua8":{},"adipisicingd59":{}},{"ad0":{}}]},{"id":"10a12eb3-3a65-6c6d-085e-426562ce9179","remote_id":"14","name":"Platform","folder_url":"https://drive.com/1234","size":2738000,"description":"This is a wild folder.","parent_folder":"6c72cdbf-74ff-e83f-d988-16471e7dbbc8","drive":"urn:uuid:e9f75191-ba0c-843d-7cd0-f9c58516cd3d","remote_created_at":"1986-08-08T11:23:36.731Z","remote_updated_at":"1990-06-03T15:35:17.225Z","field_mappings":{"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},"remote_data":[{"ut__":{},"id_cc":{}},{"nisi_2":{},"ex_5":{}}]}]}