GET api/REST/2.0/assets/email/signature/rules

Retrieves a list of signature rule assets.

Request parameters

Name

Description

Constraints

depth

Level of detail returned by the request. Learn more about the depth parameter.

Possible values:

"minimal"

"partial"

"complete"

Example:?depth=complete

count Maximum number of entities to return Any whole number between 1 and 1000 inclusive.

Example:
?count=100

page

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.

Any positive whole number.

Example:?page=3&count=10

search

The search parameter specifies the search criteria to use to filter the results. The syntax for the search parameter is:
search={term}{operator}{value}. Learn more about the search URL parameter.

{term} is the name of a field or property to filter on, {operator} is the comparison operator, and {value} is the value to compare the term with. If {term} and {operator} are not supplied, the term is compared to the value using the equality operator. Searches can be for exact full matches, or partial matches. A "*" symbol can be used after the {value} for partial matches.

If there are spaces in the value, the value needs to be placed in single quotes. Otherwise, single quotes are not required.

You can search with fields even if they are not returned at the depth being used.

The following operators are supported on most endpoints:

  • = (Equal To)
  • != (Not equal to)
  • > (Greater than)
  • < (Less than)
  • >= (Greater than or Equal to)
  • <= (Less than or Equal to)


Example:
GET .../data/contacts?search=id=1

sort Specifies the name of the property used to sort the returned entities.

The value depends on the type of entity being sorted, with each entity having its own list of sortable properties.

Example:
GET .../data/contacts?sort=firstName

dir Specifies the direction in which to sort the returned entities.

"asc" for ascending or "desc" for descending.

Example:
GET .../data/contacts?sort=firstName&dir=asc

orderBy

Specifies the field by which list results are ordered, and the direction. The direction will defaullt to ASC if not specified.

Any valid asset parameter field.

Example:
?orderBy=createdAt
?orderBy=createdAt DESC
?orderBy=createdAt ASC

lastUpdatedAt

When the asset was last updated. Returns deleted assets.Note: For the majority of use cases, it is recommended to use updatedAt with the search URL parameter. For example: ?search='updatedAt>518862600'

A valid date/time value.

Example:
?lastUpdatedAt=518862600

Response parameters

Name

Type

Description

Possible values

type

string

The asset's type in Eloqua.

EmailSignatureRule

id string Id of the signature rule.  
createdAt string The date and time the signature rule was created.  
createdBy string The login id of the user who created the signature rule.  
depth string The request's level of detail.
  • minmal
  • partial
  • complete

name

string

The name of the signature rule.

 
updatedAt string Unix timestamp for the date and time the signature rule was last updated.  
updatedBy string The login id of the user that last updated the signature rule.  
isPersonalizeFromAddress string Whether or not the email sender's "From" address is customized in the email header.  
isPersonalizeFromName string Whether or not the email sender's "Display Name" is customized in the email header.  
isPersonalizeReplyAddress string Whether or not the "Reply-To Address" is customized in the email header.  
isPersonalizeReplyName string Whether or not the "Reply-To Display Name" is customized in the email header.  

Example

Retrieve the first two signature rules in your database:

GET /assets/email/signature/rules?count=2

Response:

{
  "elements": [
    {
      "type": "EmailSignatureRule",
      "id": "2",
      "createdAt": "1417724000",
      "createdBy": "12",
      "depth": "minimal",
      "name": "EC Test Signature Rule",
      "updatedAt": "1471936138",
      "updatedBy": "71",
      "isPersonalizeFromAddress": null,
      "isPersonalizeFromName": null,
      "isPersonalizeReplyAddress": null,
      "isPersonalizeReplyName": null
    },
    {
      "type": "EmailSignatureRule",
      "id": "115",
      "createdAt": "1460656435",
      "createdBy": "2",
      "depth": "minimal",
      "name": "rl 480 Signature Rule",
      "updatedAt": "1460656861",
      "updatedBy": "2",
      "isPersonalizeFromAddress": null,
      "isPersonalizeFromName": null,
      "isPersonalizeReplyAddress": null,
      "isPersonalizeReplyName": null
    }
  ],
  "page": 1,
  "pageSize": 2,
  "total": 96
}