Search recipients

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

Search recipients by various criteria including name, email, type, bank account details, and metadata. The Search API provides powerful full-text search capabilities across all recipients.

---

Request Parameters

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query string. Searches across recipient name, email, description, bank account details, and metadata. Supports multiple words (AND logic) and partial matches.

Example:"john doe"

`filters`OBJECT(optional)

Filter criteria to narrow search results. Common filters include type, active status, verified status, and created date ranges.

Example:{"type":"individual","verified":true,"active":true}

Optional - 3 fieldsPagination Parameters

▼

---

Responses

200

Successful search

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

Response includes:

• data - Array of recipient 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
• Invalid filter field names

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 unavailable.

Common causes:

• Incorrect endpoint URL
• Search feature not enabled for account

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/recipients/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "query=john doe" \
  -d "filters[type]=individual" \
  -d "filters[verified]=true"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Recipient.search({
  query: 'john doe',
  filters: {
    type: 'individual',
    verified: true
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Recipient.search(
    query='john doe',
    filters={
        'type': 'individual',
        'verified': True
    }
)

Node.js

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

const results = await omise.recipients.search({
  query: 'john doe',
  filters: {
    type: 'individual',
    verified: true
  }
});

PHP

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

$results = OmiseRecipient::search([
    'query' => 'john doe',
    'filters' => [
        'type' => 'individual',
        'verified' => true
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("type", "individual");
filters.put("verified", true);

SearchResult<Recipient> results = client.recipients()
    .search()
    .query("john doe")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Recipients.Search(new SearchRequest
{
    Query = "john doe",
    Filters = new Dictionary<string, object>
    {
        { "type", "individual" },
        { "verified", true }
    }
});

Go

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

results, _ := client.Recipients().Search(&operations.SearchRecipients{
    Query: "john doe",
    Filters: map[string]interface{}{
        "type":     "individual",
        "verified": true,
    },
})

---

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

Search Filter Options

Filter	Type	Description
type	string	Recipient type (individual, corporation)
verified	boolean	Whether recipient is verified (true/false)
active	boolean	Whether recipient is active (true/false)
bank_account_brand	string	Bank code (bbl, kbank, scb, etc.)
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})

---

🔑API Credentials

▼

Try it out

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...