Global Search

GET

/api/:account_id/search

GET

/api/:account_id/search

$ curl https://app.paymentkit.com/api/account_id/search \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "query": "cus_prod_12345",
3   "mode": "id_lookup",
4   "sections": [
5     {
6       "type": "customer",
7       "label": "Customers",
8       "results": [
9         {
10           "type": "customer",
11           "id": "cus_prod_12345",
12           "href": "customers?id=cus_prod_12345",
13           "title": "Acme Corporation",
14           "subtitle": "cus_prod_12345 · Enterprise Account",
15           "id_label": "cus_prod_12345",
16           "right_meta": "Active since 12 Mar 2022",
17           "status_label": "Active",
18           "status_color": "green",
19           "match": {
20             "field": "id"
21           }
22         }
23       ],
24       "has_more": false,
25       "see_all_href": null
26     }
27   ]
28 }

Unified search across customers, payments, invoices, etc.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

qstringOptional<=100 charactersDefaults to

Free-text query. < 2 chars returns mode='empty'. When the query looks like an entity ID (cus_prod_…, in_dev_…, etc.), the response switches to mode='id_lookup' and returns at most one entity from the matching section.

Response

Successful Response

querystring

The trimmed query that was searched.

modeenum

Which search mode produced the results.

sectionslist of objects

Result sections in display order. Empty list when no entity matched (the frontend renders the ‘No results’ empty state). Order: customers, payments, invoices, subscriptions, products, coupons, packages, meters, upgrade paths, then pages.

Errors

422

Unprocessable Entity Error