Retrieve a list of contact segments

get

/api/REST/1.0/assets/contact/segments

Retrieves all contact segments that match the criteria specified by the request parameters.

Request

Supported Media Types
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.
  • Unix timestamp for the date and time the contact segment was last updated.
  • Specifies the field by which list results are ordered.
  • Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : QueryResultSegment
Type: object
Title: QueryResultSegment
Show Source
Nested Schema : elements
Type: array
Array of segment fields.
Show Source
Nested Schema : ContactSegment
Type: object
Title: ContactSegment
Show Source
Nested Schema : elements
Type: array
Array of contact segment elements.
Show Source
Nested Schema : SegmentElement
Type: object
Title: SegmentElement
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve the first contact segment in your database:


GET /api/REST/1.0/assets/contact/segments?count=1
			

Response:


{
    "elements":[
        {
            "type":"ContactSegment",
            "currentStatus":"Draft",
            "id":"2",
            "createdAt":"1430851032",
            "createdBy":"19",
            "depth":"minimal",
            "folderId":"312",
            "name":"Test Segment",
            "permissions":"fullControl",
            "updatedAt":"1430851034",
            "updatedBy":"19"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":1
}
			
Back to Top