v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Questions

Endpoints to interact with questions

Operations

GET/api/v2/questionsPOST/api/v2/questionsGET/api/v2/questions/{id}DELETE/api/v2/questions/{id}PATCH/api/v2/questions/{id}POST/api/v2/questions/bulk-deleteGET/api/v2/questions/localizations

---

Get questions

GET

/api/v2/questions

Returns a list of questions

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

types

Filter questions by types

groupId

Filter questions by group ID

Type

integer

Example1

Responses

Question list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/questions

Playground

Authorization

bearerAuth

Variables

Key

Value

types

groupId

Samples

---

Create a new question

POST

/api/v2/questions

Create question

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Question created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/questions

Playground

Authorization

bearerAuth

Body

Samples

---

Get question by ID

GET

/api/v2/questions/{id}

Returns a single question

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Question Id

Type

integer

Required

Format

"int64"

Query Parameters

localizations

To include localized question and answer. Example: ?localizations=en,fr, ?localizations=* for all available localizations

Type

string

Responses

Question object with relation answers, group, and tags

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/questions/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

localizations

Samples

---

Delete a question

DELETE

/api/v2/questions/{id}

Deletes a question

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of the question to delete

Type

integer

Required

Format

"int64"

Responses

Question deleted successfully

DELETE

/api/v2/questions/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update a question

PATCH

/api/v2/questions/{id}

Update an existing question

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of the question to update

Type

integer

Required

Format

"int64"

Request Body

application/json

"string"

Responses

Question updated

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/questions/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Delete multiple questions

POST

/api/v2/questions/bulk-delete

Deletes multiple questions

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

[

  

  

  

1,

  

  

  

2,

  

  

  

3

  

  

]

  

]

}

Responses

Questions deleted successfully

POST

/api/v2/questions/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Get question localizations

GET

/api/v2/questions/localizations

Get question localizations

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Question list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/questions/localizations

Playground

Authorization

bearerAuth

Samples

---

Powered by VitePress OpenAPI