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:    


{
  "username": "johndoe",
  "usertoken": "abc123abc123abc123abc123abc123",
  "requesttype": "Segments",
  "requestmethod": "GetSegments",
  "details": {
    "pagination": { /* optional: default return all at once */
      "limit": "{*max_records*}", /* required */
      "next": "{*start_at_record_number*}" /* optional: default 0 */
    }
  }
}
JavaScript


 "json_request"  element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeSegments
requestmethodGetSegments


"details"  element


Field NameDescription
pagination
(optional)		default is to return all segments at once
limitlimit the max number of segments return
nextstart at a specific record numberdefault is 0 


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if lists found for the user name supplied


"response"

"data"

"item" element - One will be returned for each segment


Field NameDescription
owneridAccount owner ID
segmentidSegment ID
segmentnameSegment name
createdateThe create date timestamp 
contactsNumber of contacts in segment at time of API call


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED when unsuccessful
errormessageText explaining why request failed