Retrieve a contact segment

get

/api/REST/2.0/assets/contact/segment/{id}

Retrieves the contact segment specified by the id parameter.

Request

Supported Media Types
Path Parameters
Query Parameters
  • 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 complete by default. For more information, see Request depth.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ContactSegment
Type: object
Title: ContactSegment
Show Source
Nested Schema : elements
Type: array
Array of contact segment elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact segment granted to your current instance. This is a read-only property.
Show Source
Nested Schema : SegmentElement
Type: object
Title: SegmentElement
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact segment element granted to your current instance. This is a read-only property.
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 contact segment whose Id is 70:


GET /api/REST/2.0/assets/contact/segment/70
Content-Type: application/json
			

Response:


{
  "type": "ContactSegment",
  "currentStatus": "Draft",
  "id": "70",
  "createdAt": "1501002060",
  "createdBy": "9",
  "depth": "complete",
  "folderId": "1267",
  "name": "My new segment name",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update"
  ],
  "updatedAt": "1501002674",
  "updatedBy": "9",
  "elements": [],
  "isStale": "True"
}
			
Back to Top