Create a project

curl --request POST \
  --url https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Name of the new project",
  "survey": {
    "pages": []
  },
  "color": "3632a8"
}
'

import requests

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

payload = {
    "title": "Name of the new project",
    "survey": { "pages": [] },
    "color": "3632a8"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: 'Name of the new project', survey: {pages: []}, color: '3632a8'})
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Name of the new project',
    'survey' => [
        'pages' => [
                
        ]
    ],
    'color' => '3632a8'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"title\": \"Name of the new project\",\n  \"survey\": {\n    \"pages\": []\n  },\n  \"color\": \"3632a8\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Name of the new project\",\n  \"survey\": {\n    \"pages\": []\n  },\n  \"color\": \"3632a8\"\n}")
  .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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Name of the new project\",\n  \"survey\": {\n    \"pages\": []\n  },\n  \"color\": \"3632a8\"\n}"

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

{
  "createdAt": "2021-09-16T23:54:53.801Z",
  "updatedAt": "2021-09-16T23:54:53.801Z",
  "title": "Name of the new project",
  "status": "draft",
  "survey": {
    "pages": []
  },
  "customization": {
    "foregroundColor": "#00b3be",
    "backgroundColor": "#ffffff",
    "question": {
      "font": "Source Sans Pro",
      "color": "#000000",
      "align": "left"
    },
    "answer": {
      "font": "Source Sans Pro",
      "color": "#000000",
      "align": "center"
    },
    "showNumbers": true,
    "paging": "page",
    "mobilePaging": "page",
    "progressBar": {
      "enabled": true,
      "type": "percent"
    }
  },
  "stats": {
    "questions": {
      "totalCount": 0,
      "contactInfoRelatedItemsCount": 0
    },
    "totalResponsesCount": 0,
    "totalTimeToComplete": 0
  },
  "hasSignatureConfirmation": false,
  "isLive": false,
  "id": "6143d94d9e3abc0d3b382733",
  "color": "Hex color without the # symbol (e.g. 3632a8)",
  "lastResponsesRecreationDate": "2021-09-16T23:54:53.799Z"
}

Projects Dashboard / Projects

Create a project

Description

Create a new SightX project.

Payload

{
    "title": "string",
    "survey": {
        "pages": array
    },
    "color": "string"
}

where:

title: Title of the new project. Required.
survey: Object containing the pages of the projects. Optional.
color: Hex color without the # symbol (e.g. 3632a8). Optional.

Response

200 OK

{
    "createdAt": "string",
    "id": "string",
    "isLive": "boolean",
    "status": "string",
    "title": "string",
    "survey": "object"
}

where:

createdAt: Date of creation of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
id: Id of the project.
isLive: Wether the project is live or not. It is false by default.
status: The status of the project. When the project is created, it will be draft by default.
survey: Object containing the survey structure, eg. pages, questions, etc.
- pages: Array of page objects. Empty by default.
customization: Object containing the survey visual configurations.
- foregroundColor: Color of the text of the survey.
- backgroundColor: Color of the background of the elements of the survey.
- question: Object containing question title configurations.
  - font: The font of the question title.
  - color: The color of the font of the question title.
  - align: The position to align the question title.
- answer: Object containing answers configurations.
  - font: The font of the answers.
  - color: Font color of the answers.
  - align: The position to align the answers.
- showNumbers: Boolean value to specify if numbers are displayed next to question titles.
- paging: String value containing the type of the pagination of the survey for desktop. Accepted values are page|question|none.
- mobilePaging: String value containing the type of the pagination of the survey for mobile. Accepted values are page|question|none.
- progressBar: Object containing the survey progress bar configurations.
  - enabled: Boolean value to specify if the progress bar should be displayed or not.
  - type: The type of progress bar to display. Accepted values are bar|percent|simple|none.
stats: Object containing some relevant stats of the project.
- questions: Object containing question stats.
  - totalCount: Total number of questions present in the survey.
  - contactInfoRelatedItemsCount: Total number of contact info items to relate.
- totalResponsesCount: Deprecated.
- totalTimeToComplete: Deprecated.
hasSignatureConfirmation: Boolean value to specify if the survey asks for a signature confirmation before starting.- createdAt: Date of creation of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
id: Id of the project.
isLive: Wether the project is live or not. It is false by default.
status: The status of the project. When the project is created, it will be draft by default.
survey: Object containing the survey structure, eg. pages, questions, etc.
- pages: Array of page objects. Empty by default.
customization: Object containing the survey visual configurations.
- foregroundColor: Color of the text of the survey.
- backgroundColor: Color of the background of the elements of the survey.
- question: Object containing question title configurations.
  - font: The font of the question title.
  - color: The color of the font of the question title.
  - align: The position to align the question title.
- answer: Object containing answers configurations.
  - font: The font of the answers.
  - color: Font color of the answers.
  - align: The position to align the answers.
- showNumbers: Boolean value to specify if numbers are displayed next to question titles.
- paging: String value containing the type of the pagination of the survey for desktop. Accepted values are page|question|none.
- mobilePaging: String value containing the type of the pagination of the survey for mobile. Accepted values are page|question|none.
- progressBar: Object containing the survey progress bar configurations.
  - enabled: Boolean value to specify if the progress bar should be displayed or not.
  - type: The type of progress bar to display. Accepted values are bar|percent|simple|none.
stats: Object containing some relevant stats of the project.
- questions: Object containing question stats.
  - totalCount: Total number of questions present in the survey.
  - contactInfoRelatedItemsCount: Total number of contact info items to relate.
- totalResponsesCount: Deprecated.
- totalTimeToComplete: Deprecated.
hasSignatureConfirmation: Boolean value to specify if the survey asks for a signature confirmation before starting.

401 Unauthorized

The user doesn’t have permissions.

422 Bad Request

title is missing.

500 Internal Server Error

Error occurred while processing the request.

POST

projects-api

folders

{folderId}

projects

Create a project

curl --request POST \
  --url https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Name of the new project",
  "survey": {
    "pages": []
  },
  "color": "3632a8"
}
'

import requests

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

payload = {
    "title": "Name of the new project",
    "survey": { "pages": [] },
    "color": "3632a8"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({title: 'Name of the new project', survey: {pages: []}, color: '3632a8'})
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Name of the new project',
    'survey' => [
        'pages' => [
                
        ]
    ],
    'color' => '3632a8'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"title\": \"Name of the new project\",\n  \"survey\": {\n    \"pages\": []\n  },\n  \"color\": \"3632a8\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sx-projects.sightx.io/projects-api/v2/folders/{folderId}/projects")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Name of the new project\",\n  \"survey\": {\n    \"pages\": []\n  },\n  \"color\": \"3632a8\"\n}")
  .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::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Name of the new project\",\n  \"survey\": {\n    \"pages\": []\n  },\n  \"color\": \"3632a8\"\n}"

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

{
  "createdAt": "2021-09-16T23:54:53.801Z",
  "updatedAt": "2021-09-16T23:54:53.801Z",
  "title": "Name of the new project",
  "status": "draft",
  "survey": {
    "pages": []
  },
  "customization": {
    "foregroundColor": "#00b3be",
    "backgroundColor": "#ffffff",
    "question": {
      "font": "Source Sans Pro",
      "color": "#000000",
      "align": "left"
    },
    "answer": {
      "font": "Source Sans Pro",
      "color": "#000000",
      "align": "center"
    },
    "showNumbers": true,
    "paging": "page",
    "mobilePaging": "page",
    "progressBar": {
      "enabled": true,
      "type": "percent"
    }
  },
  "stats": {
    "questions": {
      "totalCount": 0,
      "contactInfoRelatedItemsCount": 0
    },
    "totalResponsesCount": 0,
    "totalTimeToComplete": 0
  },
  "hasSignatureConfirmation": false,
  "isLive": false,
  "id": "6143d94d9e3abc0d3b382733",
  "color": "Hex color without the # symbol (e.g. 3632a8)",
  "lastResponsesRecreationDate": "2021-09-16T23:54:53.799Z"
}

Description

Create a new SightX project.

Payload

{
    "title": "string",
    "survey": {
        "pages": array
    },
    "color": "string"
}

where:

title: Title of the new project. Required.
survey: Object containing the pages of the projects. Optional.
color: Hex color without the # symbol (e.g. 3632a8). Optional.

Response

200 OK

{
    "createdAt": "string",
    "id": "string",
    "isLive": "boolean",
    "status": "string",
    "title": "string",
    "survey": "object"
}

where:

createdAt: Date of creation of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
id: Id of the project.
isLive: Wether the project is live or not. It is false by default.
status: The status of the project. When the project is created, it will be draft by default.
survey: Object containing the survey structure, eg. pages, questions, etc.
- pages: Array of page objects. Empty by default.
customization: Object containing the survey visual configurations.
- foregroundColor: Color of the text of the survey.
- backgroundColor: Color of the background of the elements of the survey.
- question: Object containing question title configurations.
  - font: The font of the question title.
  - color: The color of the font of the question title.
  - align: The position to align the question title.
- answer: Object containing answers configurations.
  - font: The font of the answers.
  - color: Font color of the answers.
  - align: The position to align the answers.
- showNumbers: Boolean value to specify if numbers are displayed next to question titles.
- paging: String value containing the type of the pagination of the survey for desktop. Accepted values are page|question|none.
- mobilePaging: String value containing the type of the pagination of the survey for mobile. Accepted values are page|question|none.
- progressBar: Object containing the survey progress bar configurations.
  - enabled: Boolean value to specify if the progress bar should be displayed or not.
  - type: The type of progress bar to display. Accepted values are bar|percent|simple|none.
stats: Object containing some relevant stats of the project.
- questions: Object containing question stats.
  - totalCount: Total number of questions present in the survey.
  - contactInfoRelatedItemsCount: Total number of contact info items to relate.
- totalResponsesCount: Deprecated.
- totalTimeToComplete: Deprecated.
hasSignatureConfirmation: Boolean value to specify if the survey asks for a signature confirmation before starting.- createdAt: Date of creation of the project in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
id: Id of the project.
isLive: Wether the project is live or not. It is false by default.
status: The status of the project. When the project is created, it will be draft by default.
survey: Object containing the survey structure, eg. pages, questions, etc.
- pages: Array of page objects. Empty by default.
customization: Object containing the survey visual configurations.
- foregroundColor: Color of the text of the survey.
- backgroundColor: Color of the background of the elements of the survey.
- question: Object containing question title configurations.
  - font: The font of the question title.
  - color: The color of the font of the question title.
  - align: The position to align the question title.
- answer: Object containing answers configurations.
  - font: The font of the answers.
  - color: Font color of the answers.
  - align: The position to align the answers.
- showNumbers: Boolean value to specify if numbers are displayed next to question titles.
- paging: String value containing the type of the pagination of the survey for desktop. Accepted values are page|question|none.
- mobilePaging: String value containing the type of the pagination of the survey for mobile. Accepted values are page|question|none.
- progressBar: Object containing the survey progress bar configurations.
  - enabled: Boolean value to specify if the progress bar should be displayed or not.
  - type: The type of progress bar to display. Accepted values are bar|percent|simple|none.
stats: Object containing some relevant stats of the project.
- questions: Object containing question stats.
  - totalCount: Total number of questions present in the survey.
  - contactInfoRelatedItemsCount: Total number of contact info items to relate.
- totalResponsesCount: Deprecated.
- totalTimeToComplete: Deprecated.
hasSignatureConfirmation: Boolean value to specify if the survey asks for a signature confirmation before starting.

401 Unauthorized

The user doesn’t have permissions.

422 Bad Request

title is missing.

500 Internal Server Error

Error occurred while processing the request.

Authorizations

Authorization

string

header

required

Access token obtained from the m2m-token endpoint.

Headers

Authorization

string

required

Authorization token

Body

application/json

The body is of type object.

Response

Successful response

Soft delete a project List projects within a folder

⌘I

​Description

​Payload

​Response

​200 OK

​401 Unauthorized

​422 Bad Request

​500 Internal Server Error

Authorizations

Headers

Body

Response

Description

Payload

Response

200 OK

401 Unauthorized

422 Bad Request

500 Internal Server Error