Jump to

• Request
• Response
• Examples

Retrieve Account Folders

get

/rest/api/v1.3/folders

Retrieves all folders in your account.

Request

Query Parameters

• limit: integer
  Number of folders to return in the response (defaults to 200 and cannot exceed 200)
• offset: integer
  Starts at 0 and indicates the record number for the response result set

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Retrieve Folders

Type: object

Title: Retrieve Folders

Show Source

• folders(optional): array folders
  Array of Folders in an Account

{
    "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."
                    }
                }
            }
        }
    }
}

Nested Schema : folders

Type: array

Array of Folders in an Account

Show Source

• Array of: object items

{
    "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."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId(optional): string
  Account ID of the Folder.
• createdBy(optional): string
  Folder Created by.
• createdDate(optional): string
  Create Date of the Folder.
• id(optional): string
  ID of the Folder.
• modifiedBy(optional): string
  Last Modified by.
• modifiedDate(optional): string
  Last Modified Date.
• name(optional): string
  Name of the Folder.
• new(optional): boolean
  Is the Folder a new Folder.
• objectType(optional): string
  Type of the Object(Folder).
• objSource(optional): string
  Folder Source.
• status(optional): string
  Status of the Folder(A or D).
• subType(optional): string
  SubType of the Folder.

{
    "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."
        }
    }
}

Back to Top

Examples

Retrieve folders in your Responsys account.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

Sample Request:

Retrieve the first 2 folders within your account.

  /rest/api/v1.3/folders?limit=2&offset=1
	

Sample Response: Success

{
    "folders": [
        {
            "id": 14729180,
            "subType": "GENERIC",
            "name": "!!!!!!!!!!!!!DM630",
            "objSource": "0",
            "accountId": 1277,
            "status": "A",
            "createdBy": 105427,
            "modifiedBy": 105427,
            "createdDate": 1549275574000,
            "modifiedDate": 1549275574000,
            "objectType": "Folder",
            "new": false
        },
        {
            "id": 4729294,
            "subType": "GENERIC",
            "name": "!!!!!!!!!!!DssORMFolderExport",
            "objSource": "0",
            "accountId": 1277,
            "status": "A",
            "createdBy": 105427,
            "modifiedBy": 105427,
            "createdDate": 1540377035000,
            "modifiedDate": 1540377035000,
            "objectType": "Folder",
            "new": false
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "/rest/api/v1.3/folders?limit=2&offset=1",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "/rest/api/v1.3/folders?limit=2&offset=3",
            "method": "GET"
        },
        {
            "rel": "prev",
            "href": "/rest/api/v1.3/folders?limit=2&offset=0",
            "method": "GET"
        }
    ]
}
	

Example Response:Failure

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

Back to Top