Topics

A topic represents a collection of community posts on a subject.

JSON format

Topics are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
created_at	string	true	false	When the topic was created
description	string	false	false	The description of the topic. By default an empty string
follower_count	integer	true	false	The number of users following the topic
html_url	string	true	false	The community url of the topic
id	integer	true	false	Automatically assigned when the topic is created
manageable_by	string	false	false	The set of users who can manage this topic. Allowed values are "staff", or "managers".
name	string	false	true	The name of the topic
position	integer	false	false	The position of the topic relative to other topics in the community
updated_at	string	true	false	When the topic was last updated
url	string	true	false	The API url of the topic
user_segment_id	integer	false	false	The id of the user segment to which this topic belongs

Themanageable_byattribute takes one of the following values:

Value	Users
staff	agents and managers
managers	only Help Center managers

Note thatmanageable_byis only displayed to users who can manage the topic.

Example

             
              {"created_at":"2012-04-04T09:14:57Z","description":"Security Best Practices","follower_count":332,"id":1635,"manageable_by":"staff","name":"Security"}

List Topics

GET /api/v2/community/topics

Lists all topics.

Allowed for

Agents
最终用户
Anonymous users

Pagination

Cursor pagination (recommended)
Offset pagination

SeePagination.

Code Samples

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/community/topics.json\-v -u{email_address}:{password}

              
               import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/community/topics"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/community/topics").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'GET',url:'https://support.zendesk.com/api/v2/community/topics',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://support.zendesk.com/api/v2/community/topics"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://support.zendesk.com/api/v2/community/topics")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK

              
               // Status 200 OK{"topics":[{"html_url":"https://{subdomain}.zendesk.com/hc/en-us/community/topics/10-Using-Help-Center-Tips-Tricks","id":10,"name":"Using Help Center - Tips & Tricks","url":"https://{subdomain}.zendesk.com/api/v2/community/topics/10.json"},{"html_url":"https://{subdomain}.zendesk.com/hc/en-us/community/topics/11-Using-Help-Center-Getting-Started-Guide","id":11,"name":"Using Help Center - Getting Started Guide","url":"https://{subdomain}.zendesk.com/api/v2/community/topics/11.json"}]}

Show Topic

GET /api/v2/community/topics/{topic_id}

Shows information about a single topic.

Allowed for

Agents
最终用户
Anonymous users

Parameters

Name	Type	In	Required	Description
topic_id	integer	Path	true	The unique ID of the topic

Code Samples

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/community/topics/{topic_id}.json\-v -u{email_address}:{password}

              
               import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/community/topics/360001326113"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/community/topics/360001326113").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'GET',url:'https://support.zendesk.com/api/v2/community/topics/360001326113',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://support.zendesk.com/api/v2/community/topics/360001326113"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://support.zendesk.com/api/v2/community/topics/360001326113")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK

              
               // Status 200 OK{"topic":{"description":"Security Best Practices","id":35467,"name":"Help Center-Tricks"}}

Create Topic

POST /api/v2/community/topics

Allowed for

Help Center managers

Agents with the Help Center Manager role can optionally supply acreated_atas part of thetopicobject. If it is not providedcreated_atis set to the current time.

Code Samples

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/community/topics.json\-v -u{email_address}:{password}-d'{"topic": {"name": "Help Center-Tricks"}}'\-X POST -H"Content-Type: application/json"

              
               import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/community/topics"method:="POST"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/community/topics").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""""");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("POST",body).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'POST',url:'https://support.zendesk.com/api/v2/community/topics',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://support.zendesk.com/api/v2/community/topics"headers={"Content-Type":"application/json",}response=requests.request("POST",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://support.zendesk.com/api/v2/community/topics")request=Net::HTTP::Post.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

201 Created

              
               // Status 201 Created{"topic":{"description":"Security Best Practices","id":35467,"name":"Help Center-Tricks"}}

Update Topic

PUT /api/v2/community/topics/{topic_id}

Allowed for

Help Center managers

Parameters

Name	Type	In	Required	Description
topic_id	integer	Path	true	The unique ID of the topic

Code Samples

旋度

              
               旋度-v -u{email_address}:{password}-d'{"topic": {"name": "Help Center-Tricks Updated"}}'\-X PUT -H"Content-Type: application/json"

              
               import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/community/topics/360001326113"method:="PUT"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/community/topics/360001326113").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""""");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("PUT",body).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'PUT',url:'https://support.zendesk.com/api/v2/community/topics/360001326113',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://support.zendesk.com/api/v2/community/topics/360001326113"headers={"Content-Type":"application/json",}response=requests.request("PUT",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://support.zendesk.com/api/v2/community/topics/360001326113")request=Net::HTTP::Put.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK

              
               // Status 200 OK{"topic":{"description":"Security Best Practices","id":35467,"name":"Help Center-Tricks"}}

删除Topic

DELETE /api/v2/community/topics/{topic_id}

Allowed for

Help Center managers

Parameters

Name	Type	In	Required	Description
topic_id	integer	Path	true	The unique ID of the topic

Code Samples

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/community/topics/{topic_id}.json\-v -u{email_address}:{password}-X DELETE

              
               import("fmt""io""net/http")funcmain(){url:="https://support.zendesk.com/api/v2/community/topics/360001326113"method:="DELETE"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://support.zendesk.com/api/v2/community/topics/360001326113").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("DELETE",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'DELETE',url:'https://support.zendesk.com/api/v2/community/topics/360001326113',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://support.zendesk.com/api/v2/community/topics/360001326113"headers={"Content-Type":"application/json",}response=requests.request("DELETE",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://support.zendesk.com/api/v2/community/topics/360001326113")request=Net::HTTP::删除.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

204 No Content

              
               // Status 204 No Contentnull

Help Center API

Federated Search

Topics

JSON format

Example

List Topics

Allowed for

Code Samples

Example response(s)

Show Topic

Allowed for

Parameters

Code Samples

Example response(s)

Create Topic

Allowed for

Code Samples

Example response(s)

Update Topic

Allowed for

Parameters

Code Samples

Example response(s)

删除Topic

Allowed for

Parameters

Code Samples

Example response(s)