Articles
Returns knowledge base articles, including content, locale, section, and permission details.
Table-Specific Information
Select
The provider uses the Zendesk API to process WHERE clause conditions built with the following columns and operators:- Id supports the = operator.
- Locale supports the = operator.
- CreatedAt supports the >, >= operators.
- LabelNames supports the = operator.
- SectionId supports the = operator.
- UpdatedAt supports the >, >= operators.
- CategoryId supports the = operator.
- UserId supports the = operator.
- StartTime supports the = operator.
For example, the following queries are processed server-side while other filters are processed client-side within the provider.
SELECT * FROM Articles WHERE Id = '18467349573905'
SELECT * FROM Articles WHERE Locale = 'en-us'
SELECT * FROM Articles WHERE Id = '10101734476572' and Locale = 'en-us'
SELECT * FROM Articles WHERE SectionId = '10101719909020'
SELECT * FROM Articles WHERE LabelNames = '10101718809020'
SELECT * FROM Articles WHERE CategoryId = '10101763925020'
SELECT * FROM Articles WHERE UserId = '10630617632284'
SELECT * FROM Articles WHERE StartTime = '2024-09-11T21:35:47.000'
Insert
The following columns are required to insert: Locale, PermissionGroupId, Title, SectionId, and UserSegmentId. This operation is allowed for logged-in users with the "agents" role.
INSERT INTO Articles (Locale, PermissionGroupId, Title, SectionId, UserSegmentId) VALUES ('en-us', 18214159653905, 'The Title', '18214167902481', 'null')
Update
You must specify the Id of the article to update it. You can update article-level metadata (such as its Promoted or Position), but not translation properties (such as the article's Title, Body, Locale, or Draft). This operation is allowed for logged-in users with the "agents" role.
UPDATE Articles SET Promoted = 'true' WHERE Id = '18460304837265'
Delete
You must specify the Id of the article to archive it. You can restore the article using the Help Center UI. This operation is allowed for logged-in users with the "agents" role.
DELETE FROM Articles WHERE Id = 18467236423441
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique Id automatically assigned when the article is created. | |
| AuthorId | Long | True |
The Id of the user who authored the article. Defaults to the user who made the request on create. | |
| Body | String | False |
HTML body of the article. Unsafe tags and attributes may be removed before display. For a list of safe tags and attributes, see Allowing unsafe HTML in Help Center articles in Zendesk help. | |
| CommentsDisabled | Boolean | False |
Indicates whether comments are disabled for this article. | |
| CreatedAt | Datetime | True |
The date and time when the article was created. | |
| Draft | Boolean | False |
Indicates whether the translation for the current locale is a draft. false by default. Can be set when creating but not when updating. For updating, see Translations. | |
| EditedAt | Datetime | True |
The date and time when the article was last edited in its displayed locale. | |
| HtmlUrl | String | True |
The URL of the article in Help Center. | |
| LabelNames | String | False |
An array of label names associated with this article. By default no label names are used. Only available on certain plans. | |
| Locale | String | False |
The locale that the article is being displayed in. | |
| Outdated | Boolean | True |
Deprecated. Always returns false because the source translation is always the most up-to-date translation. | |
| OutdatedLocales | String | True |
Locales in which the article was marked as outdated. | |
| PermissionGroupId | Long | False |
The Id of the permission group that defines who can edit and publish this article. | |
| Position | Integer | False |
The position of this article in the article list. Defaults to 0. | |
| Promoted | Boolean | False |
Indicates whether this article is promoted. false by default. | |
| SectionId | Long | False |
The Id of the section to which this article belongs. | |
| SourceLocale | String | True |
The source (default) locale of the article. | |
| Title | String | False |
The title of the article. | |
| UpdatedAt | Datetime | True |
The date and time when the article was last updated. | |
| Url | String | True |
The API URL of the article. | |
| UserSegmentId | Long | False |
The Id of the user segment that defines who can see this article. Set to null to make it accessible to everyone. | |
| VoteCount | Integer | True |
The total number of upvotes and downvotes. | |
| VoteSum | Integer | True |
The sum of upvotes (+1) and downvotes (-1), which may be positive or negative. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| CategoryId | Long |
The Id of the category to filter articles by. |
| UserId | Long |
The Id of the author whose articles to filter by. |
| StartTime | Datetime |
The start date and time for filtering articles by creation or update time. |