folders list

GET {{baseUrl}}/folders

Returns a list of Folder objects.

Request Params

KeyDatatypeRequiredDescription
created_afterstringIf provided, will only return objects created after this datetime.
created_beforestringIf provided, will only return objects created before this datetime.
cursorstringThe pagination cursor value.
summarystringIf provided, will only return folders in this drive.
expandstringWhich relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_databooleanWhether to include data that was marked as deleted by third party webhooks.
include_remote_databooleanWhether to include the original data Merge fetched from the third-party to produce these models.
modified_afterstringIf provided, will only return objects modified after this datetime.
modified_beforestringIf provided, will only return objects modified before this datetime.
namestringIf provided, will only return folders with this name.
page_sizenumberNumber of results to return per page.
summarystringIf provided, will only return folders in this parent folder. If null, will return folders in root directory.
remote_idstringThe API provider's ID for the given object.

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

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":{}}]}]}