Skip to navigation
RESTAdminManagementCustomer SegmentationSegments for a Shopper Profile

List Segments for Shopper Profile

Returns a paginated Segments list for a Shopper Profile.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Customersmodifystore_v2_customers
Customersread-onlystore_v2_customers_read_only

NOTE: GET endpoints require only read-only permission, except for the Get All Shopper Profiles in a Segment endpoint which requires modify permission.

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see API Accounts and OAuth Scopes.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see API Accounts and OAuth Scopes.

For a list of API status codes, see API Status Codes.

Path parameters

shopperProfileIdstringRequiredformat: "uuid"

The Shopper Profile ID.

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Query parameters

pageintegerOptional
Page number.
limitintegerOptional
Items count per page.

Response

An array of Segments objects and metadata.

datalist of objectsOptional
metaobjectOptional
Data about the response including pagination, and collection totals.