Returns owner_ID, segment_ID and related information for all segments, including number of current contacts in segment as of the time of the call.
JSON Request Example:
/**
* Users::GetSegments
*/
{
"username": "bob",
"usertoken": "abc123",
"requesttype": "Users",
"requestmethod": "GetSegments",
"details": {
"pagination": { /* optional: default return all at once */
"limit": "5", /* required */
"next": "{*start_at_record_number*}" /* optional: default 0 */
}
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | Users |
| requestmethod | GetSegments |
"details" element
| Field Name | Description |
| pagination (optional) | default is to return all segments at once |
| limit (required) | limit the max number of segments return |
| next (optional) | start at a specific record number (default is 0) |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if lists found for the user name supplied |
"response"
"data"
"item" element - One will be returned for each segment
| Field Name | Description |
| ownerid | Account owner ID |
| segmentid | Segment ID |
| segmentname | Segment name |
| createdate | The create date timestamp |
| contacts | Number of contacts in segment at time of API call |
Unsuccessful Response:
"response" element
| Field Name | Description |
| status | Will return FAILED when unsuccessful |
| errormessage | Text explaining why request failed |