Skip to content
Bottle

Find customers from a name typed roughly

GET
/customers/fuzzy
curl --request GET \
  --url 'https://example.com/customers/fuzzy?q=example&limit=8' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Closest first, by trading name, legal name or contact name. Copes with a typo, a missing letter or the words in another order. Archived customers are left out.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
required

The name, typed roughly

string
>= 2 characters <= 100 characters

The name, typed roughly

limit
integer
default: 8 >= 1 <= 20

Responses

Section titled “Responses”

200

Section titled “200”

Matches

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
tradingName
required
string
contactName
required
string | null
surchargeRule
required
string | null
Allowed values: add exclude

Example 

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "surchargeRule": "add"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

Not a member of that tenant

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

Validation failed

Media typeapplication/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"
    }
  ]
}