RetrieveRequest

The RetrieveRequest object retrieves data from the system.

NameData TypeDescription
ClientIDsArray of ClientID objectsSpecifies accounts and sub-accounts, including Enterprise 2.0, On-Your-Behalf, and Lock & Publish accounts, from which to retrieve data.
ContinueRequestStringRepresents the RequestID that identifies a previous Retrieve requestto continue processing (returns the next available batch of data for that request).
FilterFilterPartSpecifies filter to apply to retrieve.
ObjectTypeStringSpecifies whether the object is a List, Subscriber, Email, or other type of object.
OptionsRetrieveOptionsOptions associated with a request. For a Configure call, options include CREATE or DELETE.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by the client and stored by the system. These properties are accessible only via API.
PropertiesArrayOfStringSpecifies an array of property definitions available for an object type. You can retrieve allowed properties using the Describe method.
QueryAllAccountsBooleanQueries all accounts, including parent and all children, regarding an event (ignores specified ClientIDs).
RepeatLastResultBooleanUsed with RetrieveAllSinceLastBatch option to repeat returning a date-based request.
RespondToArray of AsyncResponse objectsNot used.
RetrieveAllSinceLastBatchBooleanRetrieve all data since last retrieve context. Works with added and modified data. You must include the same properties and filters as the previous request.
RetrievesArray of Request objectsNot used.