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>'

Autorisations

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

Paramètres de chemin

  • site_idstringobligatoire

    The id of a site from List sites.

  • article_idstringobligatoire

    The id of an article from List articles.

Paramètres de requête

  • localestring

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

En-têtes

  • 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.

Réponses

The article.

En-têtes

  • 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.

  • idstringobligatoire

    The article identifier.

  • typestringobligatoire
  • titlestring | nullobligatoire

    The article title.

  • slugstring | nullobligatoire

    The article's path segment on the site.

  • textstringobligatoire

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

  • urlstring | nullobligatoire

    The article's public address.

  • localestringobligatoire

    The language of this response.

  • last_updatedstring | nullobligatoire

    When the article last changed.

  • categoryobject | nullobligatoire

    The article's main category.

    • idstringobligatoire
    • titlestring | nullobligatoire
    • slugstring | nullobligatoire
  • tagsstring[]obligatoire

    The slugs of the article's tags.

  • truncatedbooleanobligatoire

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

  • authorobject | nullobligatoire

    The article author.

    • namestring | nullobligatoire
  • statusstringobligatoire
  • content_availablebooleanobligatoire

    Whether Notiondesk holds content for this language yet.

  • sync_in_progressbooleanobligatoire

    Whether a sync of this article is running.

  • sync_timeoutbooleanobligatoire

    Whether the last sync of this article timed out.

  • sync_failedbooleanobligatoire

    Whether the last sync of this article failed.

  • sync_error_codestring | nullobligatoire

    Why the last sync failed.