Sites

Updated 11 Oct, 2026 01:05 AM in API

The site is where every API session starts: it gives your site's name and the links to everything else. Your profile is the supporter the token belongs to.

Your site

Get the site

GET /yoursite
curl -H "Accept: application/vnd.tender-v1+json" \
     -H "Authorization: Bearer $TENDER_TOKEN" \
     https://api.tenderapp.com/yoursite
{
  "name": "Juniper",
  "permalink": "juniper",
  "website": null,
  "href": "https://api.tenderapp.com/yoursite",
  "categories_href": "https://api.tenderapp.com/yoursite/categories{?page}",
  "discussions_href": "https://api.tenderapp.com/yoursite/discussions{/state}{?page,user_email}",
  "sections_href": "https://api.tenderapp.com/yoursite/sections{?page}",
  "faqs_href": "https://api.tenderapp.com/yoursite/faqs{/state}{?page}",
  "profile_href": "https://api.tenderapp.com/yoursite/profile",
  "users_href": "https://api.tenderapp.com/yoursite/users{?page,email}",
  "queues_href": "https://api.tenderapp.com/yoursite/queues{?page}",
  "html_href": "https://yoursite.tenderapp.com"
}
Field
name Your site's name.
permalink The name in your site's addresses: yoursite in yoursite.tenderapp.com and in the API's URLs.
website Your product's website, from your site settings, or null.
href This resource.
categories_href Your categories.
discussions_href Your discussions; {/state} takes open, pending, resolved and the other states.
sections_href Your KB sections.
faqs_href Your KB articles; {/state} is published or draft.
profile_href Your profile.
users_href Your users; email finds one by email address.
queues_href Your queues.
html_href Your site, for people. Sites with their own domain get that domain here.

The links are URI templates: see Introduction.

The site's settings can't be changed through the API; change them in Tender.

Your profile

The profile is the supporter whose token made the request. It's a quick way to check which account a token belongs to.

Get your profile

GET /yoursite/profile
curl -H "Accept: application/vnd.tender-v1+json" \
     -H "Authorization: Bearer $TENDER_TOKEN" \
     https://api.tenderapp.com/yoursite/profile
{
  "name": "Maya Okafor",
  "email": "maya@juniper.example.com",
  "title": "Head of Support",
  "state": "support",
  "public_facing": false,
  "trusted": true,
  "company_id": null,
  "external_id": "maya@juniper.example.com",
  "enable_email_notifications": true,
  "activated_at": "2026-10-09T06:47:09Z",
  "created_at": "2026-10-09T06:47:09Z",
  "updated_at": "2026-10-09T06:47:13Z",
  "discussions_count": 0,
  "comments_count": 6,
  "href": "https://api.tenderapp.com/yoursite/users/10",
  "discussions_href": "https://api.tenderapp.com/yoursite/users/10/discussions{?page,user_email}"
}

It's the same as your own entry under Users, whose href it gives (along with avatar_url and avatar_large_url, trimmed here).

Update your profile

PUT /yoursite/profile

Send the fields to change as a JSON object. For example, your title, which customers see next to your replies:

curl -X PUT \
     -H "Accept: application/vnd.tender-v1+json" \
     -H "Authorization: Bearer $TENDER_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"title": "Support Lead"}' \
     https://api.tenderapp.com/yoursite/profile

The answer is your updated profile, as above. This needs a token with Read and write access.

Field
name Your name.
title Your title, such as "Head of Support".

Values that aren't valid get 422 with the problems by field. Your other settings (email address, password, notifications, avatar) are in Account settings in Tender.

More from the knowledge base