Get article
  • Updated on 10 May 2019
  • 2 minutes to read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Get article

  • Print
  • Share
  • Dark
    Light

GET/articles/{ID}

Gets article with an ID


Header

Parameter Type Description
api_token string REST API key you can get it from Settings > API.

Route Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
ID string ID of the article

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,
        "version_id": "15f100c5-76dc-4e4e-bc8c-32b2f903a0f7",
        "hidden": false,
        "status": 0,
        "order": 0,
        "protection_level": 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"
    },
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}

Response Data

Parameter Type Description
id string ID of the article
title string Article title
content string Article markdown cotent
html_content string Article html content
category_id string The id of the parent category
project_version_id string 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 of this article
public_version number The version number that is currently published
version_id string The id of latest article version
hidden boolean Indicates if article is visible in 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
protection_level enumerated The access requried to view the article: 0 - Public, 1 - LoggedInUsers
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

Response > Authors

Parameter Type Description
id string ID of the user
first_name string Firstname of the user
last_name string Lastname 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?