Articles have the following keys:

The sort_by key can have one of the following values:

The sort_order key can have one of the following values:

{
  "id":                1635,
  "author_id":         3465,
  "comments_disabled": false,
  ...
}

• GET /api/v2/help_center/articles.json
• GET /api/v2/help_center/{locale}/articles.json
• GET /api/v2/help_center/categories/{id}/articles.json
• GET /api/v2/help_center/sections/{id}/articles.json
• GET /api/v2/help_center/users/{id}/articles.json
• GET /api/v2/help_center/incremental/articles.json?start_time={start_time}

These endpoints let you list all articles, all articles in a locale, all articles in a given category or section, or all the articles provided by a specific agent. You can also list all articles that were updated since a specified start time.

You can also use the Search API to list articles. See Search.

• Agents
• End-users

The response lists only the articles that the requesting agent or end-user can view in Help Center.

The following sideloads are supported:

Unlike other sideloads, translations are embedded within the article because they're not shared between resources. Section and category translations are only sideloaded if present.

curl https://{subdomain}.zendesk.com/api/v2/help_center/articles.json \
  -v -u {email_address}:{password}

Status: 200 OK

{
  "articles": [
    {
      "id":        35467,
      "author_id": 888887,
      "draft":     true,
      ...
    },
    ...
  ]
}

You can use the incremental article endpoint to list all the articles that were updated since a certain date and time. The endpoint takes a start_time parameter with a Unix epoch time. Example:

GET /api/v2/help_center/incremental/articles.json?start_time=1404345231

You can specify that only articles with specific labels should be returned by adding a label_names parameter. The parameter should be a comma-separated list of label names:

• label_names (GET /api/v2/help_center/articles.json?label_names=photos,camera)

Matching is case-sensitive. For example, 'camera' matches 'camera' but not 'Camera'.

• GET /api/v2/help_center/articles/{id}.json
• GET /api/v2/help_center/{locale}/articles/{id}.json

Shows the properties of an article.

• Agents
• End users

The following sideloads are supported:

Unlike other sideloads, translations are embedded within the article because they're not shared between resources. Section and category translations are only sideloaded if present.

curl https://{subdomain}.zendesk.com/api/v2/help_center/articles/{id}.json \
  -v -u {email_address}:{password}

Status: 200 OK

{
  "article": {
    "id":                1635,
    "author_id":         3465,
    "draft":             true,
    "comments_disabled": false,
    ...
  }
}

• POST /api/v2/help_center/sections/{id}/articles.json
• POST /api/v2/help_center/{locale}/sections/{id}/articles.json

Creates an article in the specified section. You must specify an article title and locale. The locale can be omitted if it's specified in the URL. Optionally, you can specify multiple translations for the article. The specified locales must be enabled for the current Help Center.

The current user is automatically subscribed to the article and will receive notifications when it changes.

• Agents

curl https://{subdomain}.zendesk.com/api/v2/help_center/sections/{id}/articles.json \
  -d '{"article": {"promoted": false, "position": 2, \
    "comments_disabled": true, "label_names": ["photo", "tripod"], "locale": "en-us", \
    "title": "How to take pictures in low light", "body": "Use a tripod" }}' \
  -v -u {email_address}:{password} -X POST -H "Content-Type: application/json"

You can also specify multiple translations for the new article:

curl https://{subdomain}.zendesk.com/api/v2/help_center/sections/{id}/articles.json \
  -d '{"article": {"promoted": false, "position": 2, \
    "comments_disabled": true, "label_names": ["photo", "tripod"], "translations": [ \
    {"locale": "en-us", "title": "How to take pictures in low light", "body": "Use a tripod"}, \
    {"locale": "fr", "title": "Comment prendre des photos en basse lumiere", "body": "Utilisez un trepied"}]}}' \
  -v -u {email_address}:{password} -X POST -H "Content-Type: application/json"

Status: 201 Created
Location: https://{subdomain}.zendesk.com/api/v2/help_center/articles/{id}.json

{
  "article": {
    "id":                37486578,
    "author_id":         3465,
    "promoted":          false,
    "position":          42,
    "comments_disabled": true,
    "section_id":        98838,
    ...
  }
}

• PUT /api/v2/help_center/articles/{id}.json
• PUT /api/v2/help_center/{locale}/articles/{id}.json

These endpoints update article-level metadata such as its promotion status or sorting position. The endpoints do not update translation properties such as the article's title or body. See Translations.

• Agents

curl https://{subdomain}.zendesk.com/api/v2/help_center/articles/{id}.json \
  -d '{"article": {"promoted": false, "position": 42, \
       "comments_disabled": true, "label_names": ["photo", "tripod"]}}' \
  -v -u {email_address}:{password} -X PUT -H "Content-Type: application/json"

Status: 200 OK

{
  "article": {
    "id":                37486578,
    "author_id":         3465,
    "promoted":          false,
    "position":          42,
    "comments_disabled": true,
    ...
  }
}

POST /api/v2/help_center/articles/{id}/bulk_attachments.json

You can associate attachments in bulk to only one article at a time, with a maximum of 20 attachments per request.

To create the attachments, see Create Unassociated Attachment.

• Agents

curl https://{subdomain}.zendesk.com/api/v2/help_center/articles/{id}/bulk_attachments.json \
  -d '{"attachment_ids": [10002, ...]}' \
  -v -u {email_address}:{password} -X POST -H "Content-Type: application/json"

PUT /api/v2/help_center/articles/{id}/source_locale.json

The endpoint updates article source_locale property

• Agents

curl https://{subdomain}.zendesk.com/api/v2/help_center/articles/{id}/source_locale.json \
  -d '{"article_locale": "fr"}' -v -u {email_address}:{password} -X PUT \
  -H "Content-Type: application/json"

Status: 200 OK

DELETE /api/v2/help_center/articles/{id}.json

• Agents

curl https://{subdomain}.zendesk.com/api/v2/help_center/articles/{id}.json \
  -v -u {email_address}:{password} -X DELETE

Status: 204 OK