This endpoint allows you to retrieve a single segment with the given ID.
643 matches
60 actions
SendGrid
60 actions
- Get Automation Click Tracking Stats by IDGETv1.0.0
- Get Automation Stats by IDGETv1.0.0
- Get DesignGETv1.0.0
- Get information on a single suppression group.GETv1.0.0
- Get List of SegmentsGETv1.0.0
- Get remaining IPs countGETv1.0.0
- Get the default authenticationGETv1.0.0
- List all authenticated domainsGETv1.0.0
- List the authenticated domain associated with the given user.GETv1.0.0
- Retrieve a Count of RecipientsGETv1.0.0
- Retrieve a Custom FieldGETv1.0.0
- Retrieve a Global SuppressionGETv1.0.0
- Retrieve a list of currently allowed IPsGETv1.0.0
- Retrieve a segmentGETv1.0.0
- Retrieve a single campaignGETv1.0.0
- Retrieve a single listGETv1.0.0
- Retrieve a single recipientGETv1.0.0
- Retrieve a specific alertGETv1.0.0
- Retrieve a specific allowed IPGETv1.0.0
- Retrieve address whitelist mail settingsGETv1.0.0
- Retrieve all alertsGETv1.0.0
- Retrieve all API Keys belonging to the authenticated userGETv1.0.0
- Retrieve all assigned IPsGETv1.0.0
- Retrieve all CampaignsGETv1.0.0
- Retrieve all categoriesGETv1.0.0
- Retrieve all custom fieldsGETv1.0.0
- Retrieve all IP poolsGETv1.0.0
- Retrieve all IP pools an IP address belongs toGETv1.0.0
- Retrieve all IPs currently in warmupGETv1.0.0
- Retrieve all listsGETv1.0.0
- Retrieve all mail settingsGETv1.0.0
- Retrieve all recent access attemptsGETv1.0.0
- Retrieve all recipients on a ListGETv1.0.0
- Retrieve all segmentsGETv1.0.0
- Retrieve all suppression groups associated with the user.GETv1.0.0
- Retrieve all suppression groups for an email addressGETv1.0.0
- Retrieve all suppressionsGETv1.0.0
- Retrieve all suppressions for a suppression groupGETv1.0.0
- Retrieve all the IPs in a specified poolGETv1.0.0
- Retrieve an authenticated domainGETv1.0.0
- Retrieve an existing API KeyGETv1.0.0
- Retrieve bounce purge mail settingsGETv1.0.0
- Retrieve email statistics by browser.GETv1.0.0
- Retrieve email statistics by client type.GETv1.0.0
- Retrieve email statistics by country and state/province.GETv1.0.0
- Retrieve email statistics by device type.GETv1.0.0
- Retrieve email statistics by mailbox provider.GETv1.0.0
- Retrieve footer mail settingsGETv1.0.0
- Retrieve forward bounce mail settingsGETv1.0.0
- Retrieve forward spam mail settingsGETv1.0.0
- Retrieve legacy template mail settingsGETv1.0.0
- Retrieve recipientsGETv1.0.0
- Retrieve recipients on a segmentGETv1.0.0
- Retrieve reserved fieldsGETv1.0.0
- Retrieve stats by a specific client type.GETv1.0.0
- Retrieve the count of billable recipientsGETv1.0.0
- Retrieve the lists that a recipient is onGETv1.0.0
- Retrieve the warmup status for a specific IP addressGETv1.0.0
- Search recipientsGETv1.0.0
- View Scheduled Time of a CampaignGETv1.0.0
Marketing/SendGrid
Retrieve a segment
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
{
"type": "object",
"properties": {
"on-behalf-of": {
"type": "string"
},
"segment_id": {
"type": "integer"
}
},
"required": [
"segment_id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
{
"type": "object",
"required": [
"conditions",
"name"
],
"properties": {
"conditions": {
"type": "array",
"description": "The conditions for a recipient to be included in this segment.",
"items": {
"type": "object",
"required": [
"field",
"value",
"operator"
],
"properties": {
"and_or": {
"type": "string",
"enum": [
"and",
"or",
""
]
},
"field": {
"type": "string"
},
"operator": {
"type": "string",
"enum": [
"eq",
"ne",
"lt",
"gt",
"contains"
]
},
"value": {
"type": "string"
}
}
}
},
"list_id": {
"type": "integer",
"description": "The list id from which to make this segment. Not including this ID will mean your segment is created from the main contactdb rather than a list."
},
"name": {
"type": "string",
"description": "The name of this segment."
},
"recipient_count": {
"type": "number",
"description": "The count of recipients in this list. This is not included on creation of segments."
}
}
}