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

Autoryzacje

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.

idstringwymagane
The article identifier.
typestringwymagane
titlestring | nullwymagane
The article title.
slugstring | nullwymagane
The article's path segment on the site.
textstringwymagane
The article content as markdown, empty when no content is stored yet.
urlstring | nullwymagane
The article's public address.
localestringwymagane
The language of this response.
last_updatedstring | nullwymagane
When the article last changed.
categoryobject | nullwymagane
The article's main category.
- idstringwymagane
- titlestring | nullwymagane
- slugstring | nullwymagane
tagsstring[]wymagane
The slugs of the article's tags.
truncatedbooleanwymagane
true when text was cut at the 200,000-byte ceiling; the cut always falls on a whole character.
authorobject | nullwymagane
The article author.
- namestring | nullwymagane
statusstringwymagane
content_availablebooleanwymagane
Whether Notiondesk holds content for this language yet.
sync_in_progressbooleanwymagane
Whether a sync of this article is running.
sync_timeoutbooleanwymagane
Whether the last sync of this article timed out.
sync_failedbooleanwymagane
Whether the last sync of this article failed.
sync_error_codestring | nullwymagane
Why the last sync failed.