Directories

Directories

Directories

Create

client.directories.create(DirectoryCreateParamsbody?, RequestOptionsoptions?): directoryViewDirectoryViewexpandedunionDirectoryCreateResponse

post/api/v1/directories

Get

client.directories.retrieve(stringappID, RequestOptionsoptions?): directoryViewDirectoryViewexpandedunionDirectoryRetrieveResponse

get/api/v1/directories/{app_id}

List

client.directories.list(DirectoryListParamsquery?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringDirectoryListResponse

get/api/v1/directories

Delete

client.directories.delete(stringappID, DirectoryDeleteParamsparams?, RequestOptionsoptions?): DirectoryDeleteResponse

delete/api/v1/directories/{app_id}

Directory View

DirectoryView

The directory view contains a directory and an app_path which is a JSONPATH set to the location in the expand mask that the expanded app will live if requested by the expander.

ShowShow

appPathstring

optional

JSONPATH expression indicating the location of the App object in the array.

directoryappIdstringcreatedAtstringdeletedAtstringupdatedAtstringDirectory

optional

This object indicates that an app is also a directory.

Hide ParametersShow Parameters

appIdstring

optional

The ID of the app associated with the directory.

createdAtstring

optional

formatdate-time

deletedAtstring

optional

formatdate-time

updatedAtstring

optional

formatdate-time