Section
Listing
> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/sections"
{
"offset": 0,
"total": 3,
"per_page": 30,
"sections": [
{SECTION}, {SECTION}, etc
]
}
Single Section
> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/sections/12345"
{
"title": "API",
"permalink": "api",
"faqs_count": 0,
"html_href": "https://help.tenderapp.com/faqs/api",
"href": "https://api.tenderapp.com/help/sections/1234",
"faqs_href": "https://api.tenderapp.com/help/sections/1234/faqs{-opt|/|state}{state}{-opt|?|page}{-join|&|page}",
"updated_at": "2009-12-09T23:30:46Z",
"created_at": "2009-12-03T00:28:41Z"
}
Attributes
- title - the name of the section.
- permalink - the name used in section URLs.
This is auto-generated from the name if not already provided.
- beta - Only show this section and articles to
Beta Access users
- important - Only show this section and
articles to Important users
- faqs_count - Number of published FAQ articles
in this section.
- href - API URL for the section.
- html_href - Web URL for the section.
- faqs_href (readonly) - URI template for
selecting all FAQ articles in this queue. See the discussion resource for info on parsing
the URI templates for discussions.
Create a
section
> curl -H "Accept: application/vnd.tender-v1+json" \
-H "Content-Type: application/json" \
-d '{
"title": "MY TITLE",
"permalink": "title",
"important": "1",
"beta": "1"
}' \
"https://EMAIL:PASS@api.tenderapp.com/help/sections
Delete a
section
> curl -H "Accept: application/vnd.tender-v1+json" \
-X DELETE \
"https://EMAIL:PASS@api.tenderapp.com/help/sections/12345"
