Universal search

GEThttps://api.omise.co/search

Searches a scope of data based on input parameters. Use this endpoint to perform full-text search and filtered queries across charges, customers, disputes, recipients, and other resources.

---

🔑API Credentials

▼

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`scope`STRING(required)

Data type to search. Determines which resource type is searched and what filters are available.

Example:"charge"

Values:audit, charge, charge_schedule, customer, dispute, event, link, linked_account, log_entry, receipt, recipient, refund, sub_merchant, transfer, transfer_schedule, transaction

Recommended - 4 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query text for full-text search. Searches across IDs, descriptions, metadata, emails, and names depending on scope.

Example:"john@example.com"

`filters`OBJECT(optional)

Search filters to narrow results. Available filters depend on the scope. Common filters include status, amount, created date ranges.

Example:{"created":"2019/01/01..2019/12/31"}

`order`STRING(optional)

Results ordering based on creation time.

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

`page`INTEGER(optional)

Page number for pagination (1-indexed).

Example:1

Default:1

Additional - 1 fieldAdditional Parameters

▼

---

Responses

200

Successful search

Returns a search object containing paginated results in the data array.

Response structure:

• object - String value "search"
• data - Array of objects matching the scope (reverse chronological by default)
• page - Current page number
• per_page - Records per page
• total - Total records matching query
• total_pages - Total number of pages
• filters - Applied search filters
• query - Search query used
• scope - Resource type searched
• location - API endpoint path
• order - Results ordering applied

Note on pagination:

• Uses page and per_page (different from standard list endpoints)
• Results delivered in reverse chronological order by default
• Supports up to 100 results per page

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Missing required scope parameter
• Invalid scope value
• Malformed filters object
• Invalid date format in filters

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

---

Code samples

cURL

curl https://api.omise.co/search \
  -X GET \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=charge" \
  -d "query=thb" \
  -d "filters[created]=2019/01/01..2019/12/31"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = Omise::Search.execute(
  'charge',
  query: 'thb',
  filters: { created: '2019/01/01..2019/12/31' }
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = omise.Search.execute(
    'charge',
    query='thb',
    filters={'amount': '1000..2000', 'captured': 'true'}
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const search = await omise.search.list({
  scope: 'charge',
  query: 'thb',
  filters: {
    created: '2019/01/01..2019/12/31'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$search = OmiseSearch::execute([
    'scope' => 'charge',
    'query' => 'thb',
    'filters' => [
        'created' => '2019/01/01..2019/12/31'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

SearchResult<Charge> search = client.search()
    .scope(SearchScope.Charge)
    .query("thb")
    .filter("created", "2019/01/01..2019/12/31")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var search = await client.Search.Execute(new SearchRequest
{
    Scope = "charge",
    Query = "thb",
    Filters = new Dictionary<string, object>
    {
        { "created", "2019/01/01..2019/12/31" }
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

search, _ := client.Search(&operations.SearchOptions{
    Scope: "charge",
    Query: "thb",
    Filters: map[string]interface{}{
        "created": "2019/01/01..2019/12/31",
    },
})

---

Error and result codes

Common Filter Patterns

Filter Syntax	Description	Example
field=value	Exact match	status=successful
field=val1..val2	Range	amount=1000..5000
field=date..date	Date range	created=2019/01/01..2019/12/31
field=true/false	Boolean	captured=true

Available Filters by Scope

Charge scope:

• status - successful, failed, pending, expired
• amount - Exact amount or range (1000..5000)
• captured - true/false
• created - Date range (2019/01/01..2019/12/31)

Customer scope:

• created - Date range

Dispute scope:

• status - open, pending, won, lost
• created - Date range

Recipient scope:

• active - true/false
• verified - true/false

---

Try it out

Required - 1 fields

▼

scope(Required)

Recommended - 4 fields

▼

Additional - 1 fields

▼