Skip to content
Bottle

List the ids of matching customers

GET
/customers/ids
curl --request GET \
  --url 'https://example.com/customers/ids?includeArchived=true&limit=50&offset=0&sort=name&dir=asc&owing=true&kind=commercial' \
  --cookie bottle.session_token=<bottle.session_token>

Every match for the same filters as GET /customers, in the same order, up to 5000, with the full count: for selecting all of them across pages.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q

Search trading name

string
<= 100 characters

Search trading name

includeArchived
string
default: false
Allowed values: true false
limit
integer
default: 50 >= 1 <= 200
offset
integer | null
0
sort
string
default: name
Allowed values: name owed overdue
dir
string
Allowed values: asc desc
owing
string
default: false
Allowed values: true false
kind
string
Allowed values: commercial domestic
rateSet
Any of:

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

Responses

Section titled “Responses”

200

Section titled “200”

Ids

Media typeapplication/json
object
ids
required
Array<string>
total
required
integer
Example
{
  "ids": [
    "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  ]
}

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"
    }
  ]
}