Search

Search data including customers, invoices, orders, transactions and more.

Search merchant data

Search merchant's data to return resources such as customers, invoices, orders, transactions.

Request
Security:
query Parameters
sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

q
string

The default search. It will search across resources and many fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Results keyed by resource.

401

Unauthorized access, invalid credentials was used.

403

Access forbidden.

get/search
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/search?sort=string&limit=1000&offset=0&q=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]