Search Customers

GEThttps://api.omise.co/customers/search

Search and filter customers to find records by email, description, metadata, and more. The Search API provides powerful full-text search capabilities across all customers.

---

Request Parameters

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query string. Searches across customer email, description, and metadata. Supports multiple words (AND logic) and partial matches.

Example:"john@example.com"

`filters`OBJECT(optional)

Filter criteria to narrow search results. Common filters include email, description, created date ranges, and metadata fields.

Example:{"email":"john@example.com"}

Additional - 3 fieldsAdditional Parameters

▼

---

Responses

200

Successful search

Search completed successfully. Returns a search result object with matching customers in the data array.

Response includes:

• data - Array of customer objects matching the search criteria
• total - Total number of results matching the search
• total_pages - Number of pages available
• page - Current page number
• per_page - Number of results per page
• order - Sort order applied (chronological or reverse_chronological)

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid page number (below 1)
• Invalid per_page value (above 100 or below 1)
• Malformed filters object

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

404

Not found

Search endpoint not found or invalid scope.

Common causes:

• Invalid search scope
• Incorrect endpoint URL

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/customers/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=customer" \
  -d "query=john@example.com" \
  -d "filters[email]=john@example.com"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Search.execute({
  scope: 'customer',
  query: 'john@example.com',
  filters: {
    email: 'john@example.com'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Search.execute(
    scope='customer',
    query='john@example.com',
    filters={
        'email': 'john@example.com'
    }
)

Node.js

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

const results = await omise.search.execute({
  scope: 'customer',
  query: 'john@example.com',
  filters: {
    email: 'john@example.com'
  }
});

PHP

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

$results = OmiseSearch::execute([
    'scope' => 'customer',
    'query' => 'john@example.com',
    'filters' => [
        'email' => 'john@example.com'
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("email", "john@example.com");

SearchResult<Customer> results = client.search()
    .scope("customer")
    .query("john@example.com")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Search.Execute(new SearchRequest
{
    Scope = "customer",
    Query = "john@example.com",
    Filters = new Dictionary<string, object>
    {
        { "email", "john@example.com" }
    }
});

Go

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

results, _ := client.Search(&operations.SearchCustomers{
    Scope: "customer",
    Query: "john@example.com",
    Filters: map[string]interface{}{
        "email": "john@example.com",
    },
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check that parameters are valid
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_scope	Invalid search scope	Ensure scope is set to "customer"

Search Filter Options

Filter	Type	Description
email	string	Customer email address
description	string	Customer description or name
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})
metadata	object	Custom metadata key-value pairs

---

🔑API Credentials

▼

Try it out

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...