Content

Get an article

Reads one article in one language, with its content as markdown. Every status is readable.

GET
/sites/{site_id}/articles/{article_id}
cURL
curl --request GET \
  --url 'https://api.notiondesk.so/sites/{site_id}/articles/{article_id}' \
  --header 'Authorization: Bearer <token>'

Авторизация

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

Параметры пути

  • site_idstringобязательно

    The id of a site from List sites.

  • article_idstringобязательно

    The id of an article from List articles.

Параметры запроса

  • localestring

    The language to read. Defaults to the site's default_locale; an empty value reads the default.

Заголовки

  • nd-versionstring

    The contract version your integration was written against. Without it, the request uses the current version. An unknown value answers 400 invalid_version.

Ответы

The article.

Заголовки

  • nd-versionstring

    The contract version that answered the request.

  • X-RateLimit-Limitinteger

    Requests allowed per minute: 120 for GET, 20 for writes, per key or OAuth grant.

  • X-RateLimit-Remaininginteger

    Requests left in the current window.

  • Retry-Afterinteger

    Seconds until the next request is accepted; 0 while requests remain.

  • idstringобязательно

    The article identifier.

  • typestringобязательно
  • titlestring | nullобязательно

    The article title.

  • slugstring | nullобязательно

    The article's path segment on the site.

  • textstringобязательно

    The article content as markdown, empty when no content is stored yet.

  • urlstring | nullобязательно

    The article's public address.

  • localestringобязательно

    The language of this response.

  • last_updatedstring | nullобязательно

    When the article last changed.

  • categoryobject | nullобязательно

    The article's main category.

    • idstringобязательно
    • titlestring | nullобязательно
    • slugstring | nullобязательно
  • tagsstring[]обязательно

    The slugs of the article's tags.

  • truncatedbooleanобязательно

    true when text was cut at the 200,000-byte ceiling; the cut always falls on a whole character.

  • authorobject | nullобязательно

    The article author.

    • namestring | nullобязательно
  • statusstringобязательно
  • content_availablebooleanобязательно

    Whether Notiondesk holds content for this language yet.

  • sync_in_progressbooleanобязательно

    Whether a sync of this article is running.

  • sync_timeoutbooleanобязательно

    Whether the last sync of this article timed out.

  • sync_failedbooleanобязательно

    Whether the last sync of this article failed.

  • sync_error_codestring | nullобязательно

    Why the last sync failed.