Segments

GET all Segments

Changed on

Use this method to get a list of all segments associated with the account. You can sort segment results and limit the number of segments that display per page. Deleted segments are excluded from the results. For more use case information, see Get All Segments in the API guide.

get/segments

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/segments
  • Auth
    • OAuth 2
      Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Scopes: contact_data
    • or OAuth 2
      Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Token URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: contact_data

Query parameters

limitstring

The number of segments to return on a page.

sort_bystring

Specify the segment sort order to use. Sort by name (sort_by=name) in ascending order, or sort by date (sort_by=date) in descending order with the most recently updated segments listed first.

Response

Request successful.

Example response

{
  "segments": [
    {
      "name": "Re-engage contacts who did not open the last 5 campaigns.",
      "segment_id": 14,
      "created_at": "2019-04-25T11:08:00.000Z",
      "edited_at": "2019-04-25T11:08:00.000Z"
    }
  ]
}

Changes