GET user/segment_membership_list

Summary

This API request returns a list of all segments that a specific user is a member of.

Resource URL
https://api.useriq.com/api/1.0/user/segment_membership_list?user_id=john.smith@useriq.com

Resource Information
Request Type: GET
Response Format: JSON

Headers

useriq-api-key (required): Your valid API key generated from the Site settings page

Parameters

user_id: The user_id of the account to be updated with the associated custom data attribute (Note: this should match the value passed in the UserIQ tracking code as 'user-id').

Example cURL Request:

HTTP

curl \
 -H "Content-type: application/json" \
 -H "useriq-api-key: 572d7372829a3211a73d9c2cb790ffe3" \
https://api.useriq.com/api/1.0/user/segment_membership_list?user_id=john.smith@useriq.com

Example Result

{
 "page": "1",
 "results_per_page": "100",
 "total_results": 20,
 "member_segments": [ ... ]
}

Response Codes
200: OK. Request processed successfully
400: Bad Request. API request could not be understood by the server.
401: Unauthorized. Invalid API access token.

How Can We Help?

Articles in this section

Comments