Skip to content
BoxBilling

Global search across customers, invoices, subscriptions, and plans

GET
/v1/search/

Search across customers, invoices, subscriptions, and plans.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
q
required
Q

Search query string

string
>= 1 characters <= 255 characters

Search query string

limit
Limit

Maximum results per type

integer
default: 10 >= 1 <= 50

Maximum results per type

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

GlobalSearchResponse

Response for global search endpoint.

object
query
required
Query
string
results
Results
Array<object>
SearchResult

Individual search result across all resource types.

object
type
required
Type

Resource type (customer, invoice, subscription, plan)

string
id
required
Id
string
title
required
Title

Primary display title

string
subtitle
Any of:
string
url
required
Url

Resource URL path for navigation

string
total_count
required
Total Count
integer

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object