Search

Retrieve Search

Welcome to the Omise Docs! These pages should contain everything you need to know to get paid using the Omise API. This is developer-oriented documentation.If you are not a developer, you can check our comprehensive support articles for non-technical explanations of various concepts or go straight to the plugin overview.

Retrieve Search

curljavaandroidobjcjavascriptcsharpphpperlpython

curl -X GET\
-H "Accept: application/json"\
"https://api.omise.co/search?page=&per_page=&order=&query=&scope="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchApi;

import java.io.File;
import java.util.*;

public class SearchApiExample {

    public static void main(String[] args) {
        
        SearchApi apiInstance = new SearchApi();
        String scope = scope_example; // String | 
        Integer page = 56; // Integer | 
        Integer perPage = 56; // Integer | 
        String order = order_example; // String | 
        String query = query_example; // String | 
        try {
            search result = apiInstance.searchGet(scope, page, perPage, order, query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchApi#searchGet");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SearchApi;

public class SearchApiExample {

    public static void main(String[] args) {
        SearchApi apiInstance = new SearchApi();
        String scope = scope_example; // String | 
        Integer page = 56; // Integer | 
        Integer perPage = 56; // Integer | 
        String order = order_example; // String | 
        String query = query_example; // String | 
        try {
            search result = apiInstance.searchGet(scope, page, perPage, order, query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchApi#searchGet");
            e.printStackTrace();
        }
    }
}

String *scope = scope_example; // 
Integer *page = 56; //  (optional) (default to 1)
Integer *perPage = 56; //  (optional) (default to 30)
String *order = order_example; //  (optional) (default to chronological)
String *query = query_example; //  (optional)

SearchApi *apiInstance = [[SearchApi alloc] init];

[apiInstance searchGetWith:scope
    page:page
    perPage:perPage
    order:order
    query:query
              completionHandler: ^(search output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OmiseApi = require('omise_api');

var api = new OmiseApi.SearchApi()
var scope = scope_example; // {{String}} 
var opts = { 
  'page': 56, // {{Integer}} 
  'perPage': 56, // {{Integer}} 
  'order': order_example, // {{String}} 
  'query': query_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchGet(scope, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchGetExample
    {
        public void main()
        {

            var apiInstance = new SearchApi();
            var scope = scope_example;  // String | 
            var page = 56;  // Integer |  (optional)  (default to 1)
            var perPage = 56;  // Integer |  (optional)  (default to 30)
            var order = order_example;  // String |  (optional)  (default to chronological)
            var query = query_example;  // String |  (optional) 

            try
            {
                search result = apiInstance.searchGet(scope, page, perPage, order, query);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchApi.searchGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSearchApi();
$scope = scope_example; // String | 
$page = 56; // Integer | 
$perPage = 56; // Integer | 
$order = order_example; // String | 
$query = query_example; // String | 

try {
    $result = $api_instance->searchGet($scope, $page, $perPage, $order, $query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchApi->searchGet: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchApi;

my $api_instance = WWW::SwaggerClient::SearchApi->new();
my $scope = scope_example; # String | 
my $page = 56; # Integer | 
my $perPage = 56; # Integer | 
my $order = order_example; # String | 
my $query = query_example; # String | 

eval { 
    my $result = $api_instance->searchGet(scope => $scope, page => $page, perPage => $perPage, order => $order, query => $query);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchApi->searchGet: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SearchApi()
scope = scope_example # String | 
page = 56 # Integer |  (optional) (default to 1)
perPage = 56 # Integer |  (optional) (default to 30)
order = order_example # String |  (optional) (default to chronological)
query = query_example # String |  (optional)

try: 
    api_response = api_instance.search_get(scope, page=page, perPage=perPage, order=order, query=query)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchApi->searchGet: %s\n" % e)

Parameters

Name	Description
page	Integer
per_page	Integer
order	String
query	String
scope*	String Required

Responses

Status: 200

 {
  "object": {
    "pattern": "search",
    "type": "string",
    "default": "search"
  },
  "export": {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "object": {
            "pattern": "export",
            "type": "string",
            "default": "export"
          },
          "id": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean",
            "enum": [
              true,
              false
            ]
          },
          "rows": {
            "type": "integer"
          },
          "filter_params": {
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "team": {
            "type": "string"
          },
          "object_type": {
            "type": "string"
          },
          "file_type": {
            "type": "string"
          },
          "filter_type": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "download_uri": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      {
        "type": "string"
      }
    ]
  },
  "data": {
    "type": "array",
    "items": {}
  },
  "page": {
    "type": "integer"
  },
  "per_page": {
    "type": "integer"
  },
  "total": {
    "type": "integer"
  },
  "total_pages": {
    "type": "integer"
  },
  "filters": {
    "type": "object"
  },
  "location": {
    "type": "string"
  },
  "order": {
    "type": "string",
    "enum": [
      "chronological",
      "reverse_chronological"
    ]
  },
  "query": {
    "type": "string"
  },
  "scope": {
    "type": "string"
  },
  "aggregate_level": {
    "type": "integer"
  }
}