Search the help guides

GET

/help/search

const url = 'https://example.com/help/search?q=send%20invoices%20to%20Xero';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/help/search?q=send%20invoices%20to%20Xero'

Deliberately unauthenticated: Bottle Support’s front page calls it as somebody types. Returns up to eight passages from the published help guides, each with the guide, the section and a link to that section. Passages only: no written answer, and nothing about any business or account. Limited to 30 searches a minute from one address. Only https://support.getbottle.app may read the answer from a browser.

Parameters

Query Parameters

required

What to look for, in the reader’s own words

string

>= 1 characters <= 120 characters

Example

send invoices to Xero

What to look for, in the reader’s own words

Responses

200

Matching passages, best first

application/json

object

items

required

Array<object>

object

title

required

The guide

string

section

required

The section of the guide

string

text

required

A short passage from that section, as plain text

string

url

required

The section in the published help guide

string format: uri

Example

{
  "items": [
    {
      "title": "Accounting (Xero)",
      "section": "What syncs",
      "url": "https://my.getbottle.app/help/guides/accounting/#what-syncs"
    }
  ]
}

422

The search is missing or too long

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}

429

Too many searches from one address

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}