What parameters does GET /V1/customers/search accept?

This endpoint accepts 1 parameter: searchCriteria (Magento\Framework\Api\SearchCriteriaInterface) required.

GETCustomer · Magento 2.4.9 Admin · Magento_Customer::customer

GET /V1/customers/search

Q: What does the GET /V1/customers/search endpoint do in Magento 2?

GET /V1/customers/search is a Magento 2 REST endpoint in the Customer module. Retrieve customers which match a specified criteria. Requires an admin Bearer token with ACL Magento_Customer::customer.

Q: What does GET /V1/customers/search return?

The endpoint returns Magento\Customer\Api\Data\CustomerSearchResultsInterface.

Q: Does GET /V1/customers/search require authentication?

This endpoint requires an admin Bearer token with ACL: Magento_Customer::customer.

GET /V1/customers/search is a Magento 2 REST endpoint in the Customer module. Retrieve customers which match a specified criteria. Requires an admin Bearer token with ACL Magento_Customer::customer.

This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

Magento\Customer\Api\Data\CustomerSearchResultsInterface

Service contract

Magento\Customer\Api\CustomerRepositoryInterface::getList

Authorization

Admin Bearer token with ACL:

Magento_Customer::customer

Query parameters

searchCriteria Magento\Framework\Api\SearchCriteriaInterface Required

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.