Jump to

• Request
• Response
• Examples

Retrieve a list of contacts

get

/api/REST/1.0/data/contacts

Retrieves all contacts 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
  Unix timestamp for the date and time the contact was last updated. This is a read-only property.
• 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.
• viewId(optional): integer
  Id of the contact view to filter results. Must be a valid contact view id. Example: ?viewId=100006.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultContact

Type: object

Title: QueryResultContact

Show Source

• elements(optional): array elements
  Array of contact 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":"QueryResultContact",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of contact fields.",
            "items":{
                "$ref":"#/definitions/ContactRest10"
            }
        },
        "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 contact fields.

Show Source

• Array of: object Contact
  Title: Contact

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

Nested Schema : Contact

Type: object

Title: Contact

Show Source

• accessedAt(optional): string
  Read Only: true

  The date and time the contact was last accessed, expressed in Unix time.
• accountId(optional): string
  The account id in which the contact belongs. This is a read-only property.
• accountName(optional): string
  The account name in which the contact belongs.
• address1(optional): string
  The contact's first address.
• address2(optional): string
  The contact's second address.
• address3(optional): string
  The contact's third address.
• bouncebackDate(optional): string
  The contact's bounceback date.
• businessPhone(optional): string
  The contact's business phone number.
• city(optional): string
  The contact's city.
• country(optional): string
  The contact's country.
• createdAt(optional): string
  Read Only: true

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

  The login id of the user who created the contact.
• currentStatus(optional): string
  The contact'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 contact.
• emailAddress(optional): string
  The contact's email address.
• emailFormatPreference(optional): string
  The contact's email format preference.
• fax(optional): string
  The contact's fax number.
• fieldValues(optional): array fieldValues
  Array containing type and id values for all of the contactFields associated with a given contact.
• firstName(optional): string
  The contact's first name.
• id(optional): string
  Read Only: true

  Id of the contact. This is a read-only property.
• isBounceback(optional): string
  Whether or not the contact has any associated bouncebacks.
• isSubscribed(optional): string
  Whether or not the contact is subscribed.
• lastName(optional): string
  The contact's last name.
• mobilePhone(optional): string
  The contact's mobile phone number.
• name(optional): string
  The name of the contact.
• permissions(optional): string
  The permissions for the contact granted to your current instance. This is a read-only property.
• postalCode(optional): string
  The contact's postal code.
• province(optional): string
  The contact's province.
• salesPerson(optional): string
  The contact's account representative.
• subscriptionDate(optional): string
  The contact's subscription date.
• title(optional): string
  The contact's title.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• unsubscriptionDate(optional): string
  The contact's unsubscription date.
• updatedAt(optional): string
  Read Only: true

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

  The login id of the user that last updated the contact.

{
    "title":"Contact",
    "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 contact. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The contact's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the contact."
        },
        "description":{
            "type":"string",
            "description":"The description of the contact."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the contact 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 contact."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the contact was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the contact."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the contact was last updated."
        },
        "accessedAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the contact 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>."
        },
        "firstName":{
            "type":"string",
            "description":"The contact's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The contact's last name."
        },
        "emailAddress":{
            "type":"string",
            "description":"The contact's email address."
        },
        "emailFormatPreference":{
            "type":"string",
            "description":"The contact's email format preference."
        },
        "isSubscribed":{
            "type":"string",
            "description":"Whether or not the contact is subscribed."
        },
        "isBounceback":{
            "type":"string",
            "description":"Whether or not the contact has any associated bouncebacks."
        },
        "accountName":{
            "type":"string",
            "description":"The account name in which the contact belongs."
        },
        "accountId":{
            "type":"string",
            "description":"The account id in which the contact belongs. This is a read-only property."
        },
        "title":{
            "type":"string",
            "description":"The contact's title."
        },
        "subscriptionDate":{
            "type":"string",
            "description":"The contact's subscription date."
        },
        "unsubscriptionDate":{
            "type":"string",
            "description":"The contact's unsubscription date."
        },
        "bouncebackDate":{
            "type":"string",
            "description":"The contact's bounceback date."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact.",
            "items":{
                "$ref":"#/definitions/FieldValueRest10"
            }
        },
        "address1":{
            "type":"string",
            "description":"The contact's first address."
        },
        "address2":{
            "type":"string",
            "description":"The contact's second address."
        },
        "address3":{
            "type":"string",
            "description":"The contact's third address."
        },
        "city":{
            "type":"string",
            "description":"The contact's city."
        },
        "province":{
            "type":"string",
            "description":"The contact's province."
        },
        "postalCode":{
            "type":"string",
            "description":"The contact's postal code."
        },
        "country":{
            "type":"string",
            "description":"The contact's country."
        },
        "businessPhone":{
            "type":"string",
            "description":"The contact's business phone number."
        },
        "mobilePhone":{
            "type":"string",
            "description":"The contact's mobile phone number."
        },
        "fax":{
            "type":"string",
            "description":"The contact's fax number."
        },
        "salesPerson":{
            "type":"string",
            "description":"The contact's account representative."
        }
    }
}

Nested Schema : fieldValues

Type: array

Array containing type and id values for all of the contactFields associated with a given contact.

Show Source

• Array of: object FieldValue
  Title: FieldValue

{
    "type":"array",
    "description":"Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact.",
    "items":{
        "$ref":"#/definitions/FieldValueRest10"
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        }
    }
}

204 Response

No matching contacts were found in the search

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 2 contacts in your database:

GET /api/REST/1.0/data/contacts?count=2
			

Response:

{
    "elements":[
        {
            "type":"Contact",
            "id":"1",
            "createdAt":"1403034086",
            "depth":"minimal",
            "name":"[e-mail]",
            "updatedAt":"1410193024",
            "emailAddress":"[e-mail]"
        },
        {
            "type":"Contact",
            "id":"2",
            "createdAt":"1403113589",
            "depth":"minimal",
            "name":"[e-mail]",
            "updatedAt":"1403113589",
            "emailAddress":"[e-mail]"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":527
}
			

Back to Top