Get information about all folders

get

https://api.campaign.episerver.net/rest/{clientId}/folders

Get detailed information about all folders, such as parent ID, children ID or creation date. You can limit the result to root folders or filter for a specific type.

Path Params

clientId

string

required

Client ID

Query Params

limit

int32

Maximum number of retrieved folders

Default value : 100

onlyRoot

boolean

Defaults to false

If true, only root folders are included in the results

entityId

int64

ID of a folder to which a mailing, message template, custom blacklist, image, recipient list or attachment has been assigned (required if type is not provided)

type

string

enum

Filter folders by type (required if "entityId" is not provided)

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Invalid limit request. Change the limit to less than 10000.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.optivo.broadmail.v1+json

200The folders were retrieved successfully (empty result if none was found).