Get information about all folders

1 min

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 Parameters

clientIdstringrequired
Description
Client ID

Query Parameters

limitinteger<int32>
Description
Maximum number of retrieved folders Default value : 100
Format
int32
onlyRootboolean
Description
If true, only root folders are included in the results
Default
false
entityIdinteger<int64>
Description
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)
Format
int64
typestring
Description
Filter folders by type (required if "entityId" is not provided)
Allowed
mailingmessageTemplatecustomBlacklistimagerecipientListattachment

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Responses

200

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

RestFolderStreamingCollection
- elementsRestFolder[]
  - idinteger<int64>
    Description
    Folder ID
    Format
    int64
  - namestring
    Description
    Folder name
  - parentIdinteger<int64>
    Description
    Parent folder ID
    Format
    int64
  - childrenIdsinteger[]
    Description
    IDs of children folders
  - createdstring<date-time>
    Description
    Creation date
    Format
    date-time
  - linksobject[]
    Description
    Restful links
    - uriBuilderobject
    - relsstring[]
    - relstring
    - typestring
    - paramsmap<string, string>
    - titlestring
    - uristring<uri>
      Format
      uri
- countinteger<int32>
  Format
  int32
- offsetinteger<int32>
  Format
  int32
- limitinteger<int32>
  Format
  int32

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

curl

curl --request GET \
     --url 'https://api.campaign.episerver.net/rest/{clientId}/folders?onlyRoot=boolean' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/folders?onlyRoot=boolean", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/folders?onlyRoot=boolean")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.campaign.episerver.net/rest/{clientId}/folders?onlyRoot=boolean"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// The folders were retrieved successfully (empty result if none was found).
{
  "elements": [
    {
      "id": "",
      "name": "",
      "parentId": "",
      "childrenIds": [
        0
      ],
      "created": "",
      "links": [
        {
          "uriBuilder": {},
          "rels": [
            ""
          ],
          "rel": "",
          "type": "",
          "params": "",
          "title": "",
          "uri": ""
        }
      ]
    }
  ],
  "count": "",
  "offset": "",
  "limit": ""
}

400

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