Sites

The site resource can not be updated through the API (yet). All you can do is see some details and some URIs to the site's discussions, categories, and queues.

> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help"
{
  "name": "Tender",
  "permalink": "help",
  "website": "http://tenderapp.com",
  "html_href": "https://help.tenderapp.com",
  "href": "https://api.tenderapp.com/help",
  "profile_href": "https://api.tenderapp.com/help/profile",
  "users_href": "https://api.tenderapp.com/help/users{-opt|?|page,email}{-join|&|page,email}",
  "categories_href": "https://api.tenderapp.com/help/categories{-opt|?|page}{-join|&|page}",
  "discussions_href": "https://api.tenderapp.com/help/discussions{-opt|/|state}{state}{-opt|?|page,user_email}{-join|&|page,user_email}",
  "queues_href": "https://api.tenderapp.com/help/queues{-opt|?|page}{-join|&|page}",
  "sections_href": "https://api.tenderapp.com/help/sections{-opt|?|page}{-join|&|page}"
  "faqs_href": "https://api.tenderapp.com/help/faqs{-opt|/|state}{state}{-opt|?|page}{-join|&|page}",
}

Note: non-support users will not see the queues_href url, cannot access it if they attempt to access it.

Attributes

  • name - The name of the site.
  • permalink - The permalink of the site (used in the tenderapp.com host names, like help.tenderapp.com)
  • website - The URL to the product that Tender is supporting.
  • html_href - Web URL for this site.
  • href - API URL for this site.
  • profile_href - URL for the currently logged in user.
  • users_href - URL to query for the site's users.
  • categories_href - URL to query for the site's categories.
  • discussions_href - URL to query for all discussions on the site.
  • queues_href - URL to query for the site's queues.
  • sections_href - URL to query for the site's FAQ sections.
  • faqs_href - URL to query for the site's FAQ articles.