Menu

Contacts API - Segments

Elements that can be shared among more than one endpoint definition.

Retrieve all segments

Retrieve all segments

GET /contactdb/segments

This endpoint allows you to retrieve all of your segments.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Responses

object
segments
array[object]
required
name
string

The name of this segment.

list_id
integer

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.

conditions
array[object]

The conditions for a recipient to be included in this segment.

field
string
value
string
operator
string
Allowed Values: eq, ne, lt, gt, contains
and_or
string
Allowed Values: and, or,
recipient_count
number

The count of recipients in this list. This is not included on creation of segments.

object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.