Get current codebook

GET

/v2/projects/{projectId}/questions/{questionId}/codebook

const url = 'https://api.surveycoder.io/v2/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/questions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/codebook';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/questions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/codebook \
  --header 'x-api-key: <x-api-key>'

Authorizations

ApiKeyAuth

Parameters

Path Parameters

projectId

required

string format: uuid

questionId

required

string format: uuid

Responses

200

Current codebook

application/json

object

success

boolean

data

object

categories

Array<object>

object

name

required

string

codes

required

Array<object>

object

name

required

string

definition

string

sentiment

string

Allowed values: Positive Negative Neutral Mixed

Example

{
  "success": true,
  "data": {
    "categories": [
      {
        "name": "Service Quality",
        "codes": [
          {
            "name": "Fast delivery",
            "sentiment": "Positive"
          }
        ]
      }
    ]
  }
}