Search If User Exists in a Custom Segment

Determines if a specific user belongs to a custom segment. Either email or user_id should be provided in the request to search for the user; user_id will be preferred if both are provided.

Query Parameters

custom_segment_id
Type: string

Unique ID of the custom segment
email
Type: string

Email address of the user
user_id
Type: integerFormat: int64

Unique ID of the user. This is generated by Punchh.

Headers

Authorization
Type: string
required

Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".
Accept
Type: string
required

Advertises which content types the client is able to understand

Responses

application/json
application/json
application/json
application/json

get/api2/dashboard/custom_segments/members

curl 'https://SERVER_NAME_GOES_HERE.punchh.com/api2/dashboard/custom_segments/members?custom_segment_id=&email=&user_id=1' \
  --header 'Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE' \
  --header 'Accept: application/json'

Show Schema

[
  {
    "custom_segment_member_id": 84767860,
    "custom_segment_id": 15402,
    "email": "test@example.com",
    "user_id": 111111111,
    "created_at": "2018-01-10T11:54:11Z",
    "updated_at": "2018-01-10T11:54:11Z"
  }
]