Retrieve a list of option lists

get

/api/REST/1.0/assets/optionLists

Retrieves all option lists 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.
  • The date and time the option list 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 : QueryResultOptionList
Type: object
Title: QueryResultOptionList
Show Source
Nested Schema : elements
Type: array
Array of option list fields.
Show Source
Nested Schema : OptionList
Type: object
Title: OptionList
Show Source
Nested Schema : elements
Type: array
A list of option elements.
Show Source
Nested Schema : Option
Type: object
Title: Option
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

The following examples demonstrate how to retrieve option lists using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the first 2 option lists in your database:


GET /api/REST/1.0/assets/optionLists?count=2
			

Response:


{
    "elements":[
        {
            "type":"OptionList",
            "id":"1",
            "depth":"minimal",
            "name":"Lead Rating"
        },
        {
            "type":"OptionList",
            "id":"2",
            "depth":"minimal",
            "name":"Company Revenue"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":16
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/REST/1.0/assets/optionLists?count=2
			
Back to Top