Segments

Load Segment

Returns details for the specified segment. Required Access Level: ViewContacts

get/segments/{name}

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/segments/{name}
  • Auth
    API key in header X-ElasticEmail-ApiKey

Path parameters

namestring string required

string

Name of the segment you want to load. Will load all contacts if the 'All Contacts' name has been provided

Response

OK

Namestring string

Segment name

Rulestring string

SQL-like rule to determine which Contacts belong to this Segment.

Changes

No recorded changes to this operation across all 2 revisions of this API.