Search linked accounts

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

Search and filter linked accounts to find accounts by name, email, status, type, and more. The Search API provides powerful full-text search capabilities across all linked accounts on your platform.

---

Request Parameters

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

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

Example:"acme corp"

`filters`OBJECT(optional)

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

Example:{"status":"verified","type":"business"}

Additional - 3 fieldsAdditional Parameters

▼

---

Responses

200

Successful search

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

Response includes:

• object - Always "search"
• data - Array of linked account 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 feature not enabled.

Common causes:

• Linked accounts feature not enabled for your account
• 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/linked_accounts/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=acme corp" \
  -d "filters[status]=verified" \
  -d "filters[type]=business"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::LinkedAccount.search({
  query: 'acme corp',
  filters: {
    status: 'verified',
    type: 'business'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.LinkedAccount.search(
    query='acme corp',
    filters={
        'status': 'verified',
        'type': 'business'
    }
)

Node.js

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

const results = await omise.linkedAccounts.search({
  query: 'acme corp',
  filters: {
    status: 'verified',
    type: 'business'
  }
});

PHP

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

$results = OmiseLinkedAccount::search([
    'query' => 'acme corp',
    'filters' => [
        'status' => 'verified',
        'type' => 'business'
    ]
]);

Java

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

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

SearchResult<LinkedAccount> results = client.linkedAccounts()
    .search()
    .query("acme corp")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.LinkedAccounts.Search(new SearchRequest
{
    Query = "acme corp",
    Filters = new Dictionary<string, object>
    {
        { "status", "verified" },
        { "type", "business" }
    }
});

Go

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

results, _ := client.LinkedAccounts().Search(&operations.SearchLinkedAccounts{
    Query: "acme corp",
    Filters: map[string]interface{}{
        "status": "verified",
        "type":   "business",
    },
})

---

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_filter	Invalid filter field or value	Ensure filter fields are supported

Search Filter Options

Filter	Type	Description
status	string	Account status (pending, verified, suspended, rejected)
type	string	Account type (individual, business)
capabilities	array	Required capabilities (card_payments, transfers, refunds)
email	string	Exact email match
created	object	Date range filter (e.g., {gte: '2025-01-01', lte: '2025-01-31'})

Search Tips

• Use multiple words for more specific results (AND logic)
• Filter by status to find accounts needing attention
• Combine query and filters for precise searches
• Use pagination for large result sets

---

🔑API Credentials

▼

Try it out

Recommended - 2 fields

▼

Additional - 3 fields

▼

Your IP: ...Loading...