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

Ủy quyền

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.

idstringbắt buộc
The article identifier.
typestringbắt buộc
titlestring | nullbắt buộc
The article title.
slugstring | nullbắt buộc
The article's path segment on the site.
textstringbắt buộc
The article content as markdown, empty when no content is stored yet.
urlstring | nullbắt buộc
The article's public address.
localestringbắt buộc
The language of this response.
last_updatedstring | nullbắt buộc
When the article last changed.
categoryobject | nullbắt buộc
The article's main category.
- idstringbắt buộc
- titlestring | nullbắt buộc
- slugstring | nullbắt buộc
tagsstring[]bắt buộc
The slugs of the article's tags.
truncatedbooleanbắt buộc
true when text was cut at the 200,000-byte ceiling; the cut always falls on a whole character.
authorobject | nullbắt buộc
The article author.
- namestring | nullbắt buộc
statusstringbắt buộc
content_availablebooleanbắt buộc
Whether Notiondesk holds content for this language yet.
sync_in_progressbooleanbắt buộc
Whether a sync of this article is running.
sync_timeoutbooleanbắt buộc
Whether the last sync of this article timed out.
sync_failedbooleanbắt buộc
Whether the last sync of this article failed.
sync_error_codestring | nullbắt buộc
Why the last sync failed.