# Search Group Customer

\
\
This API endpoint allows users to search for a customer's business/corporate account. by providing a unique `id` or `customerID` of the account you want to use to request a query. \
\ <mark style="color:blue;">`GET`</mark> `/api/Account/v1/SearchGroupCustomers`\
\
It retrieves information about customers in a specific group (business/corporate), facilitating efficient group management and customer relationship tracking within the banking system.<br>

**Headers**

<table><thead><tr><th width="368">Name</th><th>Value</th></tr></thead><tbody><tr><td>Content-Type<mark style="color:red;">*</mark></td><td><code>application/json</code></td></tr><tr><td>Authorization<mark style="color:red;">*</mark></td><td><code>Bearer &#x3C;token></code></td></tr><tr><td>Request-Reference</td><td><code>{unique-reference}</code></td></tr></tbody></table>

**Query Parameter**

<table><thead><tr><th width="207">Name</th><th width="117">Data Type </th><th>Description</th><th data-hidden data-type="checkbox">Required</th></tr></thead><tbody><tr><td>name</td><td>string</td><td>Name of the business or entity</td><td>true</td></tr><tr><td>id</td><td>string</td><td>Unique identifier for the entity (UUID format)</td><td>false</td></tr><tr><td>customerID</td><td>string </td><td>Unique identifier for the customer</td><td>false</td></tr><tr><td>oldCustomerID</td><td>string</td><td>Previous customer identifier, if applicable</td><td>false</td></tr><tr><td>customerType</td><td>string</td><td>Type of customer (e.g., individual, business)</td><td>false</td></tr><tr><td>email</td><td>string</td><td>Email address of the business or entity</td><td>false</td></tr><tr><td>description</td><td>string</td><td>Description of the business or entity</td><td>false</td></tr><tr><td>OfficialAddress</td><td>string</td><td>Official address of the business</td><td>false</td></tr><tr><td>LGA</td><td>string</td><td>Local Government Area (LGA)</td><td>false</td></tr><tr><td>BusinessPhoneNumber</td><td>string</td><td>Business phone number</td><td>false</td></tr><tr><td>NatureOfBusiness</td><td>string</td><td>Nature of the business</td><td>false</td></tr><tr><td>IndustrialSector</td><td>string</td><td>Code representing the industrial sector</td><td>false</td></tr><tr><td>RegistrationDate</td><td>date</td><td>Date of business registration</td><td>false</td></tr><tr><td>IncorporationDate</td><td>date</td><td>Date of business incorporation</td><td>false</td></tr><tr><td>RegistrationNumber</td><td>string</td><td>Business registration number</td><td>false</td></tr><tr><td>ContactPersonName</td><td>string</td><td>Name of the contact person</td><td>false</td></tr><tr><td>ContactPersonPhoneNumber</td><td>string</td><td>Phone number of the contact person</td><td>false</td></tr><tr><td>CountryOfOperation</td><td>string</td><td>Country where the business operates</td><td>false</td></tr><tr><td>StateOfOperation</td><td>string</td><td>State where the business operates</td><td>false</td></tr><tr><td>StartDate</td><td>date</td><td>Start date for the business or activity</td><td>false</td></tr><tr><td>EndDate</td><td>date</td><td>End date for the business or activity</td><td>false</td></tr><tr><td>PageNumber</td><td>integer</td><td>Page number for pagination purposes</td><td>false</td></tr><tr><td>PageSize</td><td>integer</td><td>Number of items per page for pagination</td><td>false</td></tr><tr><td>SortColumn</td><td>string</td><td>Column by which you want to sort the results: (e.g., <code>email</code>, <code>stateOfOperation</code>)</td><td>false</td></tr><tr><td>Direction</td><td>string</td><td>Direction of the sort (e.g., <code>ascending</code>, <code>descending</code>)</td><td>false</td></tr></tbody></table>

<details>

<summary>Sample Request</summary>

```json
curl --location -g '{{baseurl}}/api/Account/v1/SearchGroupCustomers?Name=Bell%20Cuisine' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer ' \
--header 'request-reference;'
```

</details>

<details>

<summary>Response : <code>200</code></summary>

```
//request successful
```

</details>