Get an article
One article, with its category and author expanded.
GET
/
api
/
v1
/
accounts
/
{account_id}
/
portals
/
{id}
/
articles
/
{id}
Get an article
curl --request GET \
--url https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id} \
--header 'api_access_token: <api-key>'import requests
url = "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_access_token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"payload": {
"id": 1,
"slug": "publish-your-first-flow",
"title": "Publish your first flow",
"content": "A flow is a small, versioned script that can greet a customer, ask a routing question, and hand off to an agent -- all before anyone on your team sees the conversation.\n\nBuild a flow from Settings, then Flows. Every save creates a new vers…",
"description": "How flows are built, versioned, and published without disrupting live conversations.",
"status": "published",
"position": 10,
"account_id": 1,
"updated_at": 1789851404,
"meta": {},
"category": {
"id": 1,
"name": "Getting started",
"slug": "getting-started",
"locale": "en"
},
"views": null,
"author": {
"id": 1,
"account_id": 1,
"availability_status": "offline",
"auto_offline": true,
"confirmed": true,
"email": "you@example.com",
"provider": "email",
"available_name": "Alex Rivera",
"name": "Alex Rivera",
"role": "administrator",
"thumbnail": "/dashboard/images/default-contact-avatars/031.svg",
"avatar_url": "",
"illustration_avatar": true,
"accent_color": null,
"custom_role_id": null
}
}
}{
"error": "Resource could not be found"
}{
"error": "Resource could not be found"
}Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the article.
Example:
1
Response
Success
Single-article responses are wrapped in a payload key.
An article as the Help Center API renders it. Note that this is not the database row — category and author come back as nested objects rather than as category_id and author_id.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get an article
curl --request GET \
--url https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id} \
--header 'api_access_token: <api-key>'import requests
url = "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/articles/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api_access_token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"payload": {
"id": 1,
"slug": "publish-your-first-flow",
"title": "Publish your first flow",
"content": "A flow is a small, versioned script that can greet a customer, ask a routing question, and hand off to an agent -- all before anyone on your team sees the conversation.\n\nBuild a flow from Settings, then Flows. Every save creates a new vers…",
"description": "How flows are built, versioned, and published without disrupting live conversations.",
"status": "published",
"position": 10,
"account_id": 1,
"updated_at": 1789851404,
"meta": {},
"category": {
"id": 1,
"name": "Getting started",
"slug": "getting-started",
"locale": "en"
},
"views": null,
"author": {
"id": 1,
"account_id": 1,
"availability_status": "offline",
"auto_offline": true,
"confirmed": true,
"email": "you@example.com",
"provider": "email",
"available_name": "Alex Rivera",
"name": "Alex Rivera",
"role": "administrator",
"thumbnail": "/dashboard/images/default-contact-avatars/031.svg",
"avatar_url": "",
"illustration_avatar": true,
"accent_color": null,
"custom_role_id": null
}
}
}{
"error": "Resource could not be found"
}{
"error": "Resource could not be found"
}