Single article

GET https://secure.usedesk.com/uapi/support/{account_id}/articles/{id}, {account_id} — Knowledge base ID in the system, {id} — Article ID.

Warning. If you use the server version of Usedesk, you will have a different URL of methods. Check the URL for the API with our team — support@usedesk.com.

* — required fields

Parameter
Value
api_token*Channel API token


PHP request example
$baseId = 2;
$articleId = 96;
$data = array(
    'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
);
$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://secure.usedesk.com/uapi/support/'. $baseId .'/' . $articleId . '?' . http_build_query($data));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
curl_close($curl);

return $result;


Example of a response from server
{
    "id": 96,
    "title": "How to sign in",
    "text": "\u003Cp\u003EPress \u003Cem\u003EStart \u003C\/em\u003E\u003Cbr\u003EFill in all the fields\u003Cbr\u003EConfirm your phone number \u003Cbr\u003ECheck your email \u003C\/p\u003E\u003Cp\u003Eprivate\u003C\/p\u003E",
    "public": 0,
    "order": 4,
    "is_rating": 0,
    "rating": {
        "positive": 0,
        "negative": 0
    },
    "category_id": 34,
    "collection_id": 123,
    "views": 46,
    "created_at": "2017-08-02 06:14:41"
}


Description of response parameters

ParameterDescription
idArticle ID
titleArticle Title
textArticle text
publicFlag indicating the publicity of the article
orderThe order in which the article is displayed
is_ratingFlag indicating the ability to rate the article
ratingRating array
  • positive — positive ratings number;
  • negative — negative ratings number
category_idCategory ID
category_titleCategory name
collection_idSection ID
collection_imageSection image
viewsNumber of views
created_atCreation date