List all projects

GET

/v2/projects

const url = 'https://api.surveycoder.io/v2/projects';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.surveycoder.io/v2/projects \
  --header 'x-api-key: <x-api-key>'

Authorizations

ApiKeyAuth

Responses

200

List of projects

application/json

object

success

boolean

data

Array<object>

object

string format: uuid

name

string

language

string

coding_type

string

status

string

Allowed values: pending in_progress completed

created_at

string format: date-time

questions

Array<object>

object

string format: uuid

text

string

status

string

Allowed values: pending codebook_ready coding coded

coding_type

string

response_count

integer

Example

{
  "success": true,
  "data": [
    {
      "name": "Q4 NPS Survey",
      "language": "en",
      "coding_type": "qualitative",
      "status": "pending",
      "questions": [
        {
          "text": "What did you like most about our service?",
          "status": "pending"
        }
      ]
    }
  ]
}

401

Missing or invalid API key.

application/json

Standard error envelope.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code. See the error reference for the full list.

string

message

required

Human-readable explanation of what went wrong.

string

request_id

Echo of the X-Request-Id header, when provided.

string format: uuid

doc_url

Link to documentation for this specific error code.

string format: uri

Example

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "x-api-key header is required",
    "doc_url": "https://docs.surveycoder.io/errors/unauthorized"
  }
}