Retrieve segment groups

Use this interface to retrieve all segment groups for an account.

Service URL:

/rest/api/v1.3/lists/segmentGroups/records

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Query Parameters:

Tip: Leave the following parameters set to their default values and use the prev and next links returned in the response to get additional programs as needed.

  • offset: starts at 0 and indicates the record number for the response result set (defaults to 0).
  • limit: number of proof lists to return in the response (defaults to 200 and cannot exceed 200).

Request Body:

None

Sample Response in case of success:

{
    "segmentGroups": [
        {
            "name": "SegmentGroup1",
            "description": null,
            "profileExtensionName": null,
            "listName": "Profile_List1",
            "folderName": "Folder1",
            "createdBy": "api.user",
            "createdDate": 1604390400000,
            "modifiedBy": "api.user",
            "modifiedDate": 1604390400000
        },
        {
            "name": "SegmentGroup2",
            "description": null,
            "profileExtensionName": null,
            "listName": "Profile_List2",
            "folderName": "Folder2",
            "createdBy": "api.user",
            "createdDate": 1558249200000,
            "modifiedBy": "api.user",
            "modifiedDate": 1558249200000
        },
        {
            "name": "AnotherSegmentGroup",
            "description": "random description",
            "profileExtensionName": null,
            "listName": "Profile_List3",
            "folderName": "Folder3",
            "createdBy": "api.user",
            "createdDate": 1594278000000,
            "modifiedBy": "api.user",
            "modifiedDate": 1594278000000
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "/rest/api/v1.3/lists/segmentGroups/records?offset=5&limit=3",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "/rest/api/v1.3/lists/segmentGroups/records?limit=3&offset=8",
            "method": "GET"
        },
        {
            "rel": "prev",
            "href": "/rest/api/v1.3/lists/segmentGroups/records?limit=3&offset=2",
            "method": "GET"
        }
    ]
}

Sample Response in case of failure:

{
   "type": "",
   "title": "Segment not found",
   "errorCode": "SEGMENT_NOT_FOUND",
   "detail": "No segment group found in this account",
   "errorDetails": []
}