Jump to

• Request
• Response

Retrieves a contact

get

/api/rest/2.0/data/contact/{id}

Retrieves the contact specified by the id parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Id of the contact

Query Parameters

• depth: 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.
• viewId: string
  The user's default contact view identifier.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Contact

Type: object

Title: Contact

Show Source

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

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

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

  The folder id of the folder which contains the contact.
• id: string
  Read Only: true

  Id of the contact. This is a read-only property.
• isBounceback: string
  Whether or not the contact has any associated bouncebacks.
• isSmsSubscribed: string
  Whether or not the contact is subscribed for SMS.
• isSubscribed: string
  Whether or not the contact is subscribed.
• lastName: string
  The contact's last name.
• mobilePhone: string
  The contact's mobile phone number.
• name: string
  The name of the contact.
• nextEvaluationTime: string
  The time when the contact is scheduled to be processed. This is a read-only property. This property can only be retrieved when a stepid is provided.
• permissions: array permissions
  The permissions for the contact granted to your current instance. This is a read-only property.
• postalCode: string
  The contact's postal code.
• province: string
  The contact's province.
• salesPerson: string
  The contact's account representative.
• scheduledFor: string
  Read Only: true

  The date the contact is scheduled.
• sourceTemplateId: string
  Id of the template used to create the asset.
• stepEntryTime: string
  The time the contact was added to a step. This is a read-only property. This property can only be retrieved when a stepid is provided.
• subscriptionDate: string
  The contact's subscription date.
• title: string
  The contact's title.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• unsubscriptionDate: string
  The contact's unsubscription date.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the contact was last updated.
• updatedBy: 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":"array",
            "description":"The permissions for the contact granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the contact."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "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."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the contact is scheduled."
        },
        "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."
        },
        "isSmsSubscribed":{
            "type":"string",
            "description":"Whether or not the contact is subscribed for SMS."
        },
        "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/FieldValueRest20"
            }
        },
        "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."
        },
        "stepEntryTime":{
            "type":"string",
            "description":"The time the contact was added to a step. This is a read-only property. This property can only be retrieved when a <code>stepid</code> is provided."
        },
        "nextEvaluationTime":{
            "type":"string",
            "description":"The time when the contact is scheduled to be processed. This is a read-only property.  This property can only be retrieved when a <code>stepid</code> is provided."
        }
    }
}

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/FieldValueRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the contact granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the contact granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

• id: string
  Read Only: true

  The id of the field to be set to the corresponding value.
• name: string
  Name of the field value.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• value: 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."
        },
        "name":{
            "type":"string",
            "description":"Name of the field value."
        }
    }
}

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