Search API

The Search API allows you to retrieve the results of searches across various scopes of data. See Search Query and Filters for supported scopes. Search results are delivered in reverse chronological order by default.

Attributes

Name Type Description
object string

The string search.

location string

API path to retrieve the current search object.

data array

Paginated search results.

export object_id

The export identifier matching /xprt(_test)?_[0-9a-z]+/.

filters object

Search filters (see search query and filters).

order string

Search results order.

page integer

Page for paginated results.

per_page integer

Records per page for paginated results.

query string

Search query (see search query and filters).

scope string

Search scope (type of data searched). See available scopes in Search Query and Filters

total integer

Number of records returned.

total_pages integer

Number of pages of records returned.

Example

  • JSON Response

- GET https://api.omise.co/search

Searches a scope of data based on input parameters. Note: the pagination mechanism for search results is different from that for lists. Use page and per_page instead of offset and limit.

Request Parameters

Name Type Description
scope string

(required) Search scope (type of data searched). See available scopes in Search Query and Filters

filters object

(optional) Search filters (see search query and filters).

order string

(optional, default: reverse_chronological) Search results order.

page integer

(optional) Page for paginated results.

per_page integer

(optional) Records per page for paginated results. Default: 30. Maximum: 100.

query string

(optional) Search query (see search query and filters).

Example

  • Search using query and filters