List projects within a folder

curl --request GET \
  --url https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects \
  --header 'Authorization: <api-key>'

import requests

url = "https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "projectId": "5e11514fbd816803d1be5e50",
    "project": {
      "createdAt": "2020-01-05T03:00:31.006Z",
      "updatedAt": "2020-01-05T06:25:31.098Z",
      "title": "Logic + Cond",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 5,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e11514fbd816803d1be5e50"
    }
  },
  {
    "projectId": "5e3c833d5012fa0099725b1c",
    "project": {
      "createdAt": "2020-02-06T21:21:01.243Z",
      "updatedAt": "2020-10-30T22:33:45.040Z",
      "title": "Full",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 3,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e3c833d5012fa0099725b1c"
    }
  },
  {
    "projectId": "5e7d179a9ba2dd0010f7f6ca",
    "project": {
      "createdAt": "2020-03-26T20:59:06.924Z",
      "updatedAt": "2020-03-26T21:01:29.543Z",
      "title": "Concept Test test",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 4,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e7d179a9ba2dd0010f7f6ca"
    }
  },
  {
    "projectId": "5e8b5b99b009f10012685bfe",
    "project": {
      "createdAt": "2020-04-06T16:40:57.266Z",
      "updatedAt": "2020-04-06T16:52:03.954Z",
      "title": "grid piped",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 3,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8b5b99b009f10012685bfe"
    }
  },
  {
    "projectId": "5e8b6499b009f10012685c0c",
    "project": {
      "createdAt": "2020-04-06T17:19:21.810Z",
      "updatedAt": "2020-04-06T17:19:21.810Z",
      "title": "sig-1588",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 0,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8b6499b009f10012685c0c"
    }
  },
  {
    "projectId": "5e8df1ebb009f10012685c70",
    "project": {
      "createdAt": "2018-05-02T16:21:33.333Z",
      "updatedAt": "2020-04-08T17:55:21.885Z",
      "title": "Shopper Trends & Analysis test 8 abril",
      "status": "published",
      "stats": {
        "totalResponsesCount": 269,
        "totalQuestionsCount": 54,
        "totalTimeToComplete": 219117,
        "questions": {
          "totalCount": 54,
          "contactInfoRelatedItemsCount": 0
        }
      },
      "id": "5e8df1ebb009f10012685c70"
    }
  },
  {
    "projectId": "5e8f7e19b009f1001268835b",
    "project": {
      "createdAt": "2020-04-09T19:57:13.735Z",
      "updatedAt": "2020-04-09T22:03:25.862Z",
      "title": "sig-1547",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 1,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8f7e19b009f1001268835b"
    }
  },
  {
    "projectId": "5e8f8326b009f10012688363",
    "project": {
      "createdAt": "2020-04-09T20:18:46.948Z",
      "updatedAt": "2020-04-09T21:31:59.879Z",
      "title": "SIG-1547",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 0,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8f8326b009f10012688363"
    }
  },
  {
    "projectId": "5e8f9aadb009f10012688367",
    "project": {
      "createdAt": "2020-04-09T21:59:09.654Z",
      "updatedAt": "2020-04-09T21:59:16.575Z",
      "title": "sig1547",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 1,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8f9aadb009f10012688367"
    }
  }
]

Projects Dashboard / Projects

List projects within a folder

Description

List the projects of the current user. You can also list projects inside a folder given the folderId. The default folderId which corresponds to the root of the projects dashboard is f00000000000000000000001.

Response

200 OK

The response is an array of objects where each object contains the information of each project.

[
    {
        "project": {
            "createdAt": "string",
            "id": "string",
            "status": "string",
            "title": "string",
            "updatedAt": "string"
        },
        "projectId": "string"
    }
]

where:

project
- createdAt: Date of creation of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
- status: Status of the project.
- title: Name of the project.
- updatedAt: Date of the last update of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
- id: Id of the project.
projectId: Id of the project.

400 Bad Request

folderId from url path is not found.

401 Unauthorized

The user doesn’t have permissions.

500 Internal Server Error

Error occurred while processing the request.

GET

projects-api

folders

{folderId}

projects

List projects within a folder

curl --request GET \
  --url https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects \
  --header 'Authorization: <api-key>'

import requests

url = "https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

[
  {
    "projectId": "5e11514fbd816803d1be5e50",
    "project": {
      "createdAt": "2020-01-05T03:00:31.006Z",
      "updatedAt": "2020-01-05T06:25:31.098Z",
      "title": "Logic + Cond",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 5,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e11514fbd816803d1be5e50"
    }
  },
  {
    "projectId": "5e3c833d5012fa0099725b1c",
    "project": {
      "createdAt": "2020-02-06T21:21:01.243Z",
      "updatedAt": "2020-10-30T22:33:45.040Z",
      "title": "Full",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 3,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e3c833d5012fa0099725b1c"
    }
  },
  {
    "projectId": "5e7d179a9ba2dd0010f7f6ca",
    "project": {
      "createdAt": "2020-03-26T20:59:06.924Z",
      "updatedAt": "2020-03-26T21:01:29.543Z",
      "title": "Concept Test test",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 4,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e7d179a9ba2dd0010f7f6ca"
    }
  },
  {
    "projectId": "5e8b5b99b009f10012685bfe",
    "project": {
      "createdAt": "2020-04-06T16:40:57.266Z",
      "updatedAt": "2020-04-06T16:52:03.954Z",
      "title": "grid piped",
      "status": "published",
      "stats": {
        "questions": {
          "totalCount": 3,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8b5b99b009f10012685bfe"
    }
  },
  {
    "projectId": "5e8b6499b009f10012685c0c",
    "project": {
      "createdAt": "2020-04-06T17:19:21.810Z",
      "updatedAt": "2020-04-06T17:19:21.810Z",
      "title": "sig-1588",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 0,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8b6499b009f10012685c0c"
    }
  },
  {
    "projectId": "5e8df1ebb009f10012685c70",
    "project": {
      "createdAt": "2018-05-02T16:21:33.333Z",
      "updatedAt": "2020-04-08T17:55:21.885Z",
      "title": "Shopper Trends & Analysis test 8 abril",
      "status": "published",
      "stats": {
        "totalResponsesCount": 269,
        "totalQuestionsCount": 54,
        "totalTimeToComplete": 219117,
        "questions": {
          "totalCount": 54,
          "contactInfoRelatedItemsCount": 0
        }
      },
      "id": "5e8df1ebb009f10012685c70"
    }
  },
  {
    "projectId": "5e8f7e19b009f1001268835b",
    "project": {
      "createdAt": "2020-04-09T19:57:13.735Z",
      "updatedAt": "2020-04-09T22:03:25.862Z",
      "title": "sig-1547",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 1,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8f7e19b009f1001268835b"
    }
  },
  {
    "projectId": "5e8f8326b009f10012688363",
    "project": {
      "createdAt": "2020-04-09T20:18:46.948Z",
      "updatedAt": "2020-04-09T21:31:59.879Z",
      "title": "SIG-1547",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 0,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8f8326b009f10012688363"
    }
  },
  {
    "projectId": "5e8f9aadb009f10012688367",
    "project": {
      "createdAt": "2020-04-09T21:59:09.654Z",
      "updatedAt": "2020-04-09T21:59:16.575Z",
      "title": "sig1547",
      "status": "draft",
      "stats": {
        "questions": {
          "totalCount": 1,
          "contactInfoRelatedItemsCount": 0
        },
        "totalResponsesCount": 0,
        "totalTimeToComplete": 0
      },
      "id": "5e8f9aadb009f10012688367"
    }
  }
]

Description

Response

200 OK

The response is an array of objects where each object contains the information of each project.

[
    {
        "project": {
            "createdAt": "string",
            "id": "string",
            "status": "string",
            "title": "string",
            "updatedAt": "string"
        },
        "projectId": "string"
    }
]

where:

project
- createdAt: Date of creation of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
- status: Status of the project.
- title: Name of the project.
- updatedAt: Date of the last update of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
- id: Id of the project.
projectId: Id of the project.

400 Bad Request

folderId from url path is not found.

401 Unauthorized

The user doesn’t have permissions.

500 Internal Server Error

Error occurred while processing the request.

Query Parameters

Parameter	Description	Required	Example
`page`	—	No	—
`limit`	—	No	—
`skip`	—	No	—
`orderField`	—	No	—
`order`	—	No	—

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Authorization token

Query Parameters

page

string

limit

string

skip

string

orderField

string

order

string

Response

List projects

The response is of type object.

Create a project List projects

⌘I

​Description

​Response

​200 OK

​400 Bad Request

​401 Unauthorized

​500 Internal Server Error

Query Parameters

Authorizations

Headers

Query Parameters

Response

Description

Response

200 OK

400 Bad Request

401 Unauthorized

500 Internal Server Error