GET /articles/{ID}/{langcode}
Gets article in given language with an ID
Header Parameter Type Description api_token string You can get the REST API from Settings > Advanced > API tokens .
Route Parameters Parameter Required Type Description ID Yes string The ID of the article langCode Yes string Language code for the multilingual website (Default language is English)
Query Parameters Parameter Required Type Description isForDisplay No
bool Set this to true, if you are displaying the article to the end-user. When true, any snippets or variables in the article will be resolved.
Response {
"data": {
"id": "eda6857b-8641-46fe-ac43-683996dc06a7",
"title": "API Document",
"content": "## Hello World",
"html_content": "<h2>Hello World</h2>\n",
"category_id": "650aec55-c0a7-42bf-862c-1eea02b98efe",
"project_version_id": "7ba483c0-0929-4bb6-aa43-04a2f4bb8893",
"version_number": 1,
"public_version": 0,
"latest_version": 1,
"enable_rtl": false",
"hidden": false,
"status": 0,
"order": 0,
"created_by": "5ae331f74e60146b233558c6",
"authors": [],
"created_at": "2019-02-19T16:45:27.478Z",
"modified_at": "2019-02-19T16:45:27.478Z",
"slug": "api-document-2",
"is_fall_back_content": false
},
"extension_data": null,
"context": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Response Data Parameter Type Description id string The ID of the article title string Article title content string Article markdown content html_content string Article HTML content category_id string The ID of the parent category project_version_id string The ID of the project version where this article is located version_number number The currently fetched version number of this article latest_version number The latest version number(revision) of this article public_version number The version number that is currently published enable_rtl boolean Indicates if Right to Left alignment is enabled for the article language hidden boolean Indicates if the article is visible on the site status enumerated The status of the article: 0 - Draft, 1 - InReview, 2 - Public, 3 - Published, 4 - Deleted order number The position inside the parent category created_by string The ID of the user that created the article authors object[] The list of authors that contributed to this article created_at DateTime The date the article was created modified_at DateTime The date the article was last modified slug string The slug of the article is_fall_back_content boolean Indicates whether the article content is a fallback of the default language content or not
Response > Authors Parameter Type Description id string The ID of the user first_name string First name of the user last_name string Last name of the user email_id string Email address of the user profile_logo_url string Profile image URL of the user user_role enumerated 1 - Administrator, 2 - Editor, 3 - DraftWriter, 4 - Reader, 7 - Owner last_login_at DateTime Last login date of the user unique_user_name string Unique username of the user
Was this article helpful?
