Content
Get an article
Reads one article in one language, with its content as markdown. Every status is readable.
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
idof a site from List sites. - article_idstringחובה
The
idof 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;
0while 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חובה
truewhentextwas 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.