Retrieve a list of events

get

/api/REST/2.0/assets/eventRegistrations

Retrieves all events 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 event 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 : QueryResultEventRegistration
Type: object
Title: QueryResultEventRegistration
Show Source
Nested Schema : elements
Type: array
Array of event field elements.
Show Source
Nested Schema : EventRegistration
Type: object
Title: EventRegistration
Show Source
Nested Schema : fields
Type: array
Array consisting of event field properties.
Show Source
Nested Schema : permissions
Type: array
This property is not used for events.
Show Source
Nested Schema : sessionFields
Type: array
Array consisting of session fields within a session.
Show Source
Nested Schema : sessionFieldValues
Type: array
Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.
Show Source
Nested Schema : sessions
Type: array
Array consisting of event sessions.
Show Source
Nested Schema : CustomObjectField
Type: object
Title: CustomObjectField
Show Source
Nested Schema : permissions
Type: array
This property is not used.
Show Source
Nested Schema : EventSessionField
Type: object
Title: EventSessionField
Show Source
Nested Schema : FieldOutputFormat
Type: object
Title: FieldOutputFormat
Show Source
Nested Schema : permissions
Type: array
This property is not used.
Show Source
Nested Schema : EventSessionFieldValue
Type: object
Title: EventSessionFieldValue
Show Source
Nested Schema : permissions
Type: array
This property is not used.
Show Source
Nested Schema : EventSession
Type: object
Title: EventSession
Show Source
Nested Schema : permissions
Type: array
This property is not used.
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 3 events in your database:


GET /api/REST/2.0/assets/eventRegistrations?count=3
			

Response:


{
  "elements": [
    {
      "type": "EventRegistration",
      "id": "5",
      "createdAt": "1458745461",
      "createdBy": "13",
      "depth": "minimal",
      "description": "",
      "folderId": "81",
      "name": "Example Event",
      "updatedAt": "1464631246",
      "updatedBy": "13"
    },
    {
      "type": "EventRegistration",
      "id": "12",
      "createdAt": "1477083116",
      "createdBy": "9",
      "depth": "minimal",
      "description": "Hotdog eating contest to be held in September 2016.",
      "folderId": "81",
      "name": "Summer 2016 Hotdog Eating Contest",
      "updatedAt": "1477083824",
      "updatedBy": "9"
    },
    {
      "type": "EventRegistration",
      "id": "13",
      "createdAt": "1477084053",
      "createdBy": "9",
      "depth": "minimal",
      "description": "Wine tasting event to be held in December 2016.",
      "folderId": "81",
      "name": "Winter 2016 Wine Tasting",
      "updatedAt": "1477084054",
      "updatedBy": "9"
    }
  ],
  "page": 1,
  "pageSize": 3,
  "total": 6
}
			
Back to Top