{
  "opencollection": "1.0.0",
  "info": {
    "name": "Catchpoint REST API v2.0 Account Folder API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Folder",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return properties of one or more folders based on folder IDs.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/folders/:folderIds",
            "params": [
              {
                "name": "folderIds",
                "value": "",
                "type": "path",
                "description": "Comma-separated list of folder IDs to look up"
              },
              {
                "name": "showInheritedProperties",
                "value": "",
                "type": "query",
                "description": "Flag to set to see inherited properties as part of the folder properties returned"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": " Results include properties from all sections available in the UI: folder Properties, Advanced Settings, Requests, Insights, Targeting & Scheduling, and Alerts.\r\n\r\nAssigning “0” to Folder ID would return the payload to create a new product."
        },
        {
          "info": {
            "name": "Return folders per the parameters.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/folders",
            "params": [
              {
                "name": "productIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of product IDs"
              },
              {
                "name": "parentFolderIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of folder IDs"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Folder name"
              },
              {
                "name": "includeAdvanceSettings",
                "value": "",
                "type": "query",
                "description": "Include advanced settings section of the folder in the response"
              },
              {
                "name": "includeRequest",
                "value": "",
                "type": "query",
                "description": "Include request settings sections of the folder in the response"
              },
              {
                "name": "includeInsight",
                "value": "",
                "type": "query",
                "description": "Include insights section of the folder in the response"
              },
              {
                "name": "includeTargeting",
                "value": "",
                "type": "query",
                "description": "Include targeting and scheduling section of the folder in the response"
              },
              {
                "name": "includeAlerts",
                "value": "",
                "type": "query",
                "description": "Include alerts section of the folder in the response"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number to return records from when the number of records exceeds pageSize"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The number of records that can be returned per page. Maximum value is 100."
              },
              {
                "name": "showInheritedProperties",
                "value": "",
                "type": "query",
                "description": "Represents if inherited properties should be shown"
              },
              {
                "name": "credentialIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of Credential IDs"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "All parameters are optional, and you may include any of them to customize the query. To pass multiple values for a parameter, provide a comma-separated list. If no parameters are passed, then details for all active folders are returned. Results include properties from all sections available in the UI: folder Properties, Advanced Settings, Requests, Insights, Targeting & Scheduling, and Alerts. The query returns 100 records per page; if there are more than 100 records then the response will have "
        },
        {
          "info": {
            "name": "Create a new folder per the request body.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/folders",
            "params": [
              {
                "name": "objectDetails",
                "value": "",
                "type": "query",
                "description": "Set to true to return the created object in the response body, otherwise the response body will only return the created object ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "The request body must include all required folder properties and may include any optional properties as well. To get a sample payload to pass along with the request, refer to the InternalLink[Folder Details by ID Endpoint,operations-tag-Folder,operations-Folder-get_v2_folders__folderIds_]\r\n\r\nTo create a folder, only the required properties need to be passed in the request body. If no details are provided for sections like targeting and scheduling, alerts, etc. then those properties will be set a"
        },
        {
          "info": {
            "name": "Update a property of an existing folder.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/folders/:folderId",
            "params": [
              {
                "name": "folderId",
                "value": "",
                "type": "path",
                "description": "Folder ID of the folder to be updated"
              },
              {
                "name": "objectDetails",
                "value": "",
                "type": "query",
                "description": "Set to true to return the updated object in the response body, otherwise the response body will only return the updated object ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Only the property to be updated can be passed in the request body (do not pass the whole object.) The update request body requires a total of three keys to be filled with appropriate value as listed below:\r\n* **value** – The value property provides the new value.\r\n\r\n* **path** – The path property indicates the element to update. The entire path with slashes needs to be provided here. Example: /status/id\r\n\r\n* **op** – The op property indicates the type of operation; we allow the following three o"
        }
      ]
    }
  ],
  "bundled": true
}