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.

Authorizations:
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
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

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

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array ()
Array of objects

List of returned customers.

Array of objects

List of returned invoices.

Array of objects

List of returned orders.

Array of objects

List of returned transactions.

searched
Array of strings

Names of searched resources, even if they returned nothing.

Request samples

curl -i -X GET \
  'https://api-sandbox.rebilly.com/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

Content type
application/json
[
  • {
    }
]