Search Segments API: searchSegments

The Search Segments API allows you to check whether a customer belongs to a specific segment by providing the segment name.

API Endpoint and Method

URL Format

Copy

https://{B2B_API_URL}/api/v1/profile/b2b/searchSegments?segmentName={}

Example URL

Copy

https://api-dev.algonomy.com/rcdpapi/api/v1/profile/b2b/searchSegments?segmentName=default

HTTP Method

POST

Request Header Parameters

Parameter	Type	Required or Optional	Description
access_token	String	Required	Specifies the access token obtained from the create access token API.
tenant_hash	String	Required	Specifies the tenant hash shared with the tenant.
gcrId	String	Required	Specifies the Golden Customer Record ID (GCR ID).
mobile_number	String	Required	Specifies customer's mobile number. Example: "1212121212"
email_address	String	Required	Specifies customer's email address. Example: "customer@example.com"
customer_code_external	String	Required	Specifies the external customer code. Example: "123456"

Notes:

You can send all the parameters (gcrId, mobile_number, and email_address) with the request or just one, as at least one parameter is required.
These parameters are supported based on the configuration. If your deployment is configured to use them as columns for deduplication, they will be available for use in the API call.

Request Body

The Search Segments API facilitates paginated responses, where the initial request to the API does not require additional pagination parameters. However, for subsequent pages, you can specify the page size and a pointer to the last record from the previous page to indicate where the next page's results should begin.

Copy

1
2
3
4
{
 "page":1,
 "pageSize": 20
}

Response Body

A successful request returns a "200-OK" status code, accompanied by the retrieved data in the response.

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "status": "OK",
  "message": "",
  "data": {
    "customerId": 2056,
    "currentPage": 1,
    "pageSize": 20,
    "totalCount": 2,
    "dataList": [
      {
        "segmentId": 26,
        "segmentName": "testABC",
        "segmentDesc": "",
        "isPushToPersonalization": false,
        "isSharedSegment": false,
        "createdDate": "15-Mar-2022 04:22:30 PM",
        "count": 23
      },
      {
        "segmentId": 25,
        "segmentName": "test123",
        "segmentDesc": "",
        "isPushToPersonalization": false,
        "isSharedSegment": false,
        "createdDate": "15-Mar-2022 03:51:16 PM",
        "count": 146
      }
    ],
    "data": null
  }
}