HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Retrieve folders

Retrieve folders from the server, along with details including title, description, and ID. Add the id parameter to only retrieve details of a specific folder. You can only retrieve folders for which you have view or edit permissions.

Recipes
🦉
Determine Folder Template Built-In and Custom Fields
Open Recipe
Query Params
integer

The ID of the folder

integer
Defaults to 1

The ID of the Document Hub whose folders you want to get.

integer
Defaults to 100

Specifies the number of folders to be fetched in one paginated request. The response may have an X-Next-Page URL parameter in the header to fetch the next set of rules or page. The default maximum value is 1000, and can be configured via alation.folder_api.max_payload_size.

integer
Defaults to 0

Specifies the number of folders to be skipped in one request. Used together with limit parameter to fetch paginated requests. This is automatically set in the X-Next-Page response header if present.

string

Filter on all textual fields of folders

boolean
Defaults to false

Will return only deleted folders when set to True.

Responses

Language
Credentials
URL
Choose an example:
application/json