KB Articles

Articles Listing

> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/faqs"
{
  "offset": 0,
  "total": 3,
  "per_page": 30,
  "faqs": [
    {Article}, {Article}, etc
  ]
}

Articles from a specific section

> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/faqs?section_id=1234"
{
  "offset": 0,
  "total": 3,
  "per_page": 30,
  "faqs": [
    {Article}, {Article}, etc
  ]
}

• section_id: The ID of the section in which to filter articles by

Single Article

> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/faqs/12345"
{
  "title": "Tender + Lighthouse discount",
  "permalink": "tender-lighthouse-discount",
  "keywords": "lighthouse discount",
  "body": "Stuff",
  "formatted_body": "<div><p>Stuff</p></div>",
  "html_href": "https://help.tenderapp.com/kb/discounts/tender-lighthouse-discount",
  "href": "https://api.tenderapp.com/help/faqs/6388",
  "section_href": "https://api.tenderapp.com/help/sections/2188",
  "published_at": "2038-01-01T08:00:00Z", # date in the future means this is a DRAFT
  "updated_at": "2009-12-03T00:28:58Z",
  "created_at": "2009-12-03T00:28:15Z"
}

Attributes

• title - the name of the KB article.
• permalink - the name used in article URLs. This is auto-generated from the name if not already provided.
• keywords - The autosuggest keywords for this article.
• body - The body content for the article.
• formatted_body (readonly) - The HTML formatted body content.
• html_href - Web URL for the article.
• href - API URL for the article.
• section_href (readonly) - API URL for the section.

Creating an article

You can POST to the faqs action to create a new KB article. Only support users can modify articles. If no published_at is given, the article is left in a draft state.

> curl -H "Accept: application/vnd.tender-v1+json" \
  -H "Content-Type: application/json" \
  -d '{"title":"MY TITLE", "keywords":"abc", "body":"MY BODY","published_at":"2010-01-01T08:00:00Z"}'
  "https://EMAIL:PASS@api.tenderapp.com/help/sections/:section_id/faqs"

Updating an article

You can PUT to the faqs resource to update it. Only support users can modify articles. If no published_at is given, the article is left in a draft state.

> curl -H "Accept: application/vnd.tender-v1+json" \
  -H "Content-Type: application/json" \
  -X PUT \
  -d '{"title":"MY TITLE"}'
  "https://EMAIL:PASS@api.tenderapp.com/help/faqs/12345"