Categories Search

Services \ Categories \ Search

Purpose

Load all categories matching a search request

Note: If the search string is empty, all categories will be returned. This will only return categories belonging to the company doing the request.

Basic Usage:

$rezdyApi->categories->search($request);

Required Parameters

• Rezdy\Requests\CategorySearch: $request

Optional Parameters

• none

Returns

• Rezdy\Responses\ResponseList

Throws (with errors)

• Rezdy\Requests\CategorySearch

Code Example

use Rezdy\RezdyAPI;
use Rezdy\Requests\CategorySearch;

// Initialize the API
$rezdyAPI = new RezdyAPI('your api key');

// Create the array of category search parameters 
$searchParams = [ 'search' => 'Other' ];

// Create the CategorySearch request
$search = new CategorySearch($searchParams);

// Send the CategorySearch request to the API
$response = $rezdyAPI->categories->search($search);

// View the Response
echo $response;