Retrieve Account Folders

Retrieves all folders in your account.

Service URL:

/rest/api/v1.3/folders

Required Path Parameters:

None

Optional Path Parameters:

Tip: Leave the following parameters set to their default values and use the “prev” and “next” links returned in the response to get additional campaigns as needed.

offset: starts at 0 and indicates the record number for the response result set (defaults to 0).
limit: number of programs to return in the response (defaults to 200 and cannot exceed 200).

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body:

Not applicable

Sample Response in case of success:

See the online API reference for a full list of the properties returned.

{
    "title":"Retrieve Folders",
    "type":"object",
    "properties":{
        "folders":{
            "description":"Array of Folders in an Account",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"ID of the Folder."
                    },
                    "name":{
                        "type":"string",
                        "description":"Name of the Folder."
                    },
                    "subType":{
                        "type":"string",
                        "description":"SubType of the Folder."
                    },
                    "objSource":{
                        "type":"string",
                        "description":"Folder Source."
                    },
                    "accountId":{
                        "type":"string",
                        "description":"Account ID of the Folder."
                    },
                    "status":{
                        "type":"string",
                        "description":"Status of the Folder(A or D)."
                    },
                    "createdBy":{
                        "type":"string",
                        "description":"Folder Created by."
                    },
                    "modifiedBy":{
                        "type":"string",
                        "description":"Last Modified by."
                    },
                    "createdDate":{
                        "type":"string",
                        "description":"Create Date of the Folder."
                    },
                    "modifiedDate":{
                        "type":"string",
                        "description":"Last Modified Date."
                    },
                    "objectType":{
                        "type":"string",
                        "description":"Type of the Object(Folder)."
                    },
                    "new":{
                        "type":"boolean",
                        "description":"Is the Folder a new Folder."
                    }
                }
            }
        }
    }
}

Sample Responses in case of failure:

Folder not found: Requests fail if there is are no folders. The error resembles:

{
  "type": "",
  "title": "Folder not found",
  "errorCode": "FOLDER_NOT_FOUND",
  "detail": "Folder [ folder_name ] not found.",
  "errorDetails": []
}