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.