Jump to

• Request
• Response
• Examples

Retrieve a list of email groups

get

/api/REST/1.0/assets/email/groups

Retrieves all email group that match the criteria specified by the request parameters.

Request

Supported Media Types

• application/json

Query Parameters

• count(optional): integer
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• depth(optional): string
  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.
• lastUpdatedAt(optional): integer
  The date and time the email group was last updated.
• orderBy(optional): string
  Specifies the field by which list results are ordered.
• page(optional): integer
  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.
• search(optional): string
  Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : QueryResultGroup

Type: object

Title: QueryResultGroup

Show Source

• elements(optional): array elements
  Array of fields.
• page(optional): integer
  The specified page.
• pageSize(optional): integer
  The page size.
• total(optional): integer
  The total amount of results.
• type(optional): string
  The asset's type in Eloqua.

{
    "title":"QueryResultGroup",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of fields.",
            "items":{
                "$ref":"#/definitions/EmailGroupRest10"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of fields.

Show Source

• Array of: object EmailGroup
  Title: EmailGroup

{
    "type":"array",
    "description":"Array of fields.",
    "items":{
        "$ref":"#/definitions/EmailGroupRest10"
    }
}

Nested Schema : EmailGroup

Type: object

Title: EmailGroup

Show Source

• accessedAt(optional): string
  Read Only: true

  The date and time the email group was last accessed, expressed in Unix time.
• createdAt(optional): string
  Read Only: true

  The date and time the email group was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the email group.
• currentStatus(optional): string
  The email group's current status.
• depth(optional): string
  Read Only: true

  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.
• description(optional): string
  The description of the email group.
• displayName(optional): string
  The display name of the email group.
• emailFooterId(optional): string
  Id of the email footer.
• emailHeaderId(optional): string
  Id of the email header.
• emailIds(optional): array emailIds
  Array containing the unique identifiers of the emails in the email group.
• id(optional): string
  Read Only: true

  Id of the email group. This is a read-only property.
• isVisibleInOutlookPlugin(optional): string
  Whether or not the email group is visible in the Outlook plugin.
• isVisibleInPublicSubscriptionList(optional): string
  Whether or not the email group is visible in the public subscriptions list.
• name(optional): string
  The name of the email group.
• permissions(optional): string
  The permissions for the email group granted to your current instance. This is a read-only property.
• subscriptionLandingPageId(optional): string
  Id of the subscription landing page.
• subscriptionListDataLookupId(optional): string
  Id of the subscription list's data lookup.
• subscriptionListId(optional): string
  Id of the subscription list. This is a read-only property.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• unsubscriptionLandingPageId(optional): string
  Id of the unsubscribe landing page.
• unSubscriptionListDataLookupId(optional): string
  Id of the unsubscribe list's data lookup.
• unSubscriptionListId(optional): string
  Id of the unsubscribe list. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the email group was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the email group.

{
    "title":"EmailGroup",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the email group. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The email group's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the email group."
        },
        "description":{
            "type":"string",
            "description":"The description of the email group."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the email group granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the email group."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the email group was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the email group."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the email group was last updated."
        },
        "accessedAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the email group was last accessed, expressed in Unix time."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "emailHeaderId":{
            "type":"string",
            "description":"Id of the email header."
        },
        "emailFooterId":{
            "type":"string",
            "description":"Id of the email footer."
        },
        "subscriptionLandingPageId":{
            "type":"string",
            "description":"Id of the subscription landing page."
        },
        "unsubscriptionLandingPageId":{
            "type":"string",
            "description":"Id of the unsubscribe landing page."
        },
        "isVisibleInPublicSubscriptionList":{
            "type":"string",
            "description":"Whether or not the email group is visible in the public subscriptions list."
        },
        "isVisibleInOutlookPlugin":{
            "type":"string",
            "description":"Whether or not the email group is visible in the Outlook plugin."
        },
        "emailIds":{
            "type":"array",
            "description":"Array containing the unique identifiers of the emails in the email group.",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the email group."
        },
        "subscriptionListId":{
            "type":"string",
            "description":"Id of the subscription list.  This is a read-only property."
        },
        "unSubscriptionListId":{
            "type":"string",
            "description":"Id of the unsubscribe list.  This is a read-only property."
        },
        "subscriptionListDataLookupId":{
            "type":"string",
            "description":"Id of the subscription list's data lookup."
        },
        "unSubscriptionListDataLookupId":{
            "type":"string",
            "description":"Id of the unsubscribe list's data lookup."
        }
    }
}

Nested Schema : emailIds

Type: array

Array containing the unique identifiers of the emails in the email group.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array containing the unique identifiers of the emails in the email group.",
    "items":{
        "type":"string"
    }
}

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 minimal details of the first 2 email groups in your database:

GET /api/REST/1.0/assets/email/groups?count=2&depth=minimal
			

Response:

{
    "elements":[
        {
            "type":"EmailGroup",
            "id":"6",
            "depth":"minimal",
            "description":"",
            "name":"Test Email Group",
            "permissions":"fullControl",
            "updatedAt":"1306513777"
        },
        {
            "type":"EmailGroup",
            "id":"18",
            "createdAt":"1432240338",
            "createdBy":"19",
            "depth":"minimal",
            "description":"",
            "name":"Test Email Group 2",
            "permissions":"fullControl",
            "updatedAt":"1432240338",
            "updatedBy":"19"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":14
}
			

Back to Top