API Documentation

Folder Resource

Search our documentation:

Toggle Documentation Menu

API: Folder Resource

Jump to...
  • List - Fetch an array of all the folders in your account
  • Get - Fetch a single folder from your account
  • List Folder Suites - Fetch an array of all the suites in a folder


List Folders

Fetch an array of all the folders in your account.

Request
GEThttps://api.ghostinspector.com/v1/folders/?apiKey=<apiKey>
Parameters
apiKey
Your API key provided in your account
Response
{
  "code": "SUCCESS",
  "data": [
    {
      "_id": "5aed177226a8722dad009e39",
      "name": "Sample Folder #1",
      "organization": "547fb82d92423992d52a4fea"
    },
    {
      "_id": "5af39b1a0d8160b28a5c4762",
      "name": "Sample Folder #2",
      "organization": "547fb82d92423992d52a4fea"
    }
  ]
}


Get Folder

Fetch a single folder

Request
GEThttps://api.ghostinspector.com/v1/folders/<folderId>/?apiKey=<apiKey>
Parameters
apiKey
Your API key provided in your account
folderId
The ID of the folder to fetch
Response
{
  "code": "SUCCESS",
  "data": {
    "_id": "5aed177226a8722dad009e39",
    "organization": "547fb82d92423992d52a4fea",
    "name": "Sample Folder #1"    
  }
}


List Folder Suites

Fetch an array of all the suites in a folder.

Request
GEThttps://api.ghostinspector.com/v1/folders/<folderId>/suites/?apiKey=<apiKey>
Parameters
apiKey
Your API key provided in your account
folderId
The ID of the folder containing the tests
Response
{
  "code": "SUCCESS",
  "data": [
    {
      "_id": "5af5f0df065bb256131adaf4",
      "abortOnTestFailure": false,
      "autoRetry": true,
      "browser": "slimerjs",
      "dateCreated": "2018-05-11T19:37:03.369Z",
      "failOnJavaScriptError": false,
      "folder": "5aed177226a8722dad009e39",
      "httpHeaders": [],
      "maxConcurrentTests": 0,
      "name": "Sample Suite #1",
      "organization": "547fb82d92423992d52a4fea",
      "persistVariables": false,
      "publicStatusEnabled": false,
      "region": "us-east-1",
      "screenshotCompareEnabled": true,
      "screenshotCompareThreshold": 0.1,
      "startUrl": "",
      "testCount": 0,
      "testFrequency": 0,
      "testFrequencyAdvanced": [],
      "variables": [],
      "viewportSize": {
        "width": 1024,
        "height": 768
      }
    },
    {
      "_id": "5af5f0df065bb256131adaf8",
      "abortOnTestFailure": false,
      "autoRetry": true,
      "browser": "slimerjs",
      "dateCreated": "2018-05-11T19:37:06.369Z",
      "failOnJavaScriptError": false,
      "folder": "5aed177226a8722dad009e39",
      "httpHeaders": [],
      "maxConcurrentTests": 0,
      "name": "Sample Suite #2",
      "organization": "547fb82d92423992d52a4fea",
      "persistVariables": false,
      "publicStatusEnabled": false,
      "region": "us-east-1",
      "screenshotCompareEnabled": true,
      "screenshotCompareThreshold": 0.1,
      "startUrl": "",
      "testCount": 0,
      "testFrequency": 0,
      "testFrequencyAdvanced": [],
      "variables": [],
      "viewportSize": {
        "width": 1024,
        "height": 768
      }
    }
  ]
}