Skip to main content
GET
/
v1
/
topics
Retrieve topics list
curl --request GET \
  --url https://api-staging.respondent.io/v1/topics \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "page": 1,
  "pageSize": 50,
  "results": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "customName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalResults": 123
}

Headers

​
x-api-key
string
required
​
x-api-secret
string
required

Query Parameters

​
page
number
default:1
​
pageSize
number
default:50
​
includeCount
boolean
default:false
​
query
string

Character Limit: min 3 and max 100

Response

200 - application/json
​
page
number
default:1
required
​
pageSize
number
default:50
required
​
results
object[]
required
​
totalResults
number

The total number of results possible, which is only provided in the response when includeCount is passed as true within a request.