Jump to

• Request
• Response

Get a single contact, Label access control is respected

get

/API/OData/OpportunityAnalysis/1/Contact/{key}

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• key(required): integer(int32)
  ContactID

Query Parameters

• $count: boolean
  Indicates whether the total count of items within a collection are returned in the result.

  Default Value: false
• $expand: string
  Indicates the related entities to be represented inline. The maximum depth is 2.
• $filter: string
  Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.
• $orderby: string
  Specifies the order in which items are returned. The maximum number of expressions is 5.
• $select: string
  Limits the properties returned in the result.
• $skip: integer(int32)
  Excludes the specified number of items of the queried collection from the result.
• $top: integer(int32)
  Limits the number of items returned from a collection. The maximum value is 10000.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Contact was successfully retrieved

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Contact

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Contact"
    }
}

Nested Schema : Contact

Type: object

Show Source

• account: object Account
• accountID: integer(int32)
• businessPhone: string
• company: string
• contactAddress1: string
• contactAddress2: string
• contactAddress3: string
• contactCity: string
• contactCountry: string
• contactId: integer(int32)
• contactStateProv: string
• contactZipPostalCode: string
• createdDate: string(date-time)
• createdDateHour: string(date-time)
• eloquaLinkedAccountId: integer(int32)
• emailAddress: string
• emailAddressDomain: string
• fax: string
• firstName: string
• lastModifiedDate: string(date-time)
• lastName: string
• leadSourceMostRecent: string
• leadSourceOriginal: string
• mobilePhone: string
• opportunities: array opportunities
• salesPerson: string
• territory: string
• title: string

{
    "type":"object",
    "properties":{
        "contactId":{
            "format":"int32",
            "type":"integer"
        },
        "createdDate":{
            "format":"date-time",
            "type":"string"
        },
        "createdDateHour":{
            "format":"date-time",
            "type":"string"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "company":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        },
        "emailAddressDomain":{
            "type":"string"
        },
        "contactAddress1":{
            "type":"string"
        },
        "contactAddress2":{
            "type":"string"
        },
        "contactAddress3":{
            "type":"string"
        },
        "contactCity":{
            "type":"string"
        },
        "contactStateProv":{
            "type":"string"
        },
        "contactZipPostalCode":{
            "type":"string"
        },
        "contactCountry":{
            "type":"string"
        },
        "businessPhone":{
            "type":"string"
        },
        "salesPerson":{
            "type":"string"
        },
        "mobilePhone":{
            "type":"string"
        },
        "fax":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "leadSourceMostRecent":{
            "type":"string"
        },
        "leadSourceOriginal":{
            "type":"string"
        },
        "territory":{
            "type":"string"
        },
        "accountID":{
            "format":"int32",
            "type":"integer"
        },
        "eloquaLinkedAccountId":{
            "format":"int32",
            "type":"integer"
        },
        "account":{
            "$ref":"#/definitions/Account"
        },
        "opportunities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Opportunity"
            }
        }
    }
}

Nested Schema : Account

Type: object

Show Source

• accountCampaignScores: array accountCampaignScores
• accountEngagement: object AccountEngagement
• accountId: integer(int32)
• accountName: string
• accountSource: integer(int32)
• companyId: integer(int32)
• contacts: array contacts
• lastModifiedDate: string(date-time)

{
    "type":"object",
    "properties":{
        "accountId":{
            "format":"int32",
            "type":"integer"
        },
        "accountName":{
            "type":"string"
        },
        "companyId":{
            "format":"int32",
            "type":"integer"
        },
        "accountSource":{
            "format":"int32",
            "type":"integer"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "accountEngagement":{
            "$ref":"#/definitions/AccountEngagement"
        },
        "accountCampaignScores":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountCampaignScore"
            }
        },
        "contacts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Contact"
            }
        }
    }
}

Nested Schema : opportunities

Type: array

Show Source

• Array of: object Opportunity

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Opportunity"
    }
}

Nested Schema : accountCampaignScores

Type: array

Show Source

• Array of: object AccountCampaignScore

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AccountCampaignScore"
    }
}

Nested Schema : AccountEngagement

Type: object

Show Source

• account: object Account
• accountContacts: integer(int32)
• accountId: integer(int32)
• engagedContacts: integer(int32)
• engagementScore: number(double)
• engagementScorePrev: number(double)
• lastModifiedDate: string(date-time)
• reachableContacts: integer(int32)

{
    "type":"object",
    "properties":{
        "accountId":{
            "format":"int32",
            "type":"integer"
        },
        "accountContacts":{
            "format":"int32",
            "type":"integer"
        },
        "engagementScore":{
            "format":"double",
            "type":"number"
        },
        "engagementScorePrev":{
            "format":"double",
            "type":"number"
        },
        "engagedContacts":{
            "format":"int32",
            "type":"integer"
        },
        "reachableContacts":{
            "format":"int32",
            "type":"integer"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "account":{
            "$ref":"#/definitions/Account"
        }
    }
}

Nested Schema : contacts

Type: array

Show Source

• Array of: object Contact

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Contact"
    }
}

Nested Schema : AccountCampaignScore

Type: object

Show Source

• account: object Account
• accountCampaignScoreId: integer(int32)
• accountId: integer(int32)
• eloquaCampaignId: integer(int32)
• lastModifiedDate: string(date-time)
• score: number(double)

{
    "type":"object",
    "properties":{
        "accountCampaignScoreId":{
            "format":"int32",
            "type":"integer"
        },
        "eloquaCampaignId":{
            "format":"int32",
            "type":"integer"
        },
        "accountId":{
            "format":"int32",
            "type":"integer"
        },
        "score":{
            "format":"double",
            "type":"number"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "account":{
            "$ref":"#/definitions/Account"
        }
    }
}

Nested Schema : Opportunity

Type: object

Show Source

• contact: object Contact
• createdDate: string(date-time)
• crmCampaignID: string
• lastModifiedDate: string(date-time)
• opportunityClosedDateHour: string(date-time)
• opportunityID: integer(int32)
• opportunityName: string
• opportunityRevenues: array opportunityRevenues
• primaryContactID: integer(int32)
• stage: string
• stageStatus: string
• territory: string
• totalOpportunityAmount: number(double)

{
    "type":"object",
    "properties":{
        "opportunityID":{
            "format":"int32",
            "type":"integer"
        },
        "opportunityName":{
            "type":"string"
        },
        "stageStatus":{
            "type":"string"
        },
        "opportunityClosedDateHour":{
            "format":"date-time",
            "type":"string"
        },
        "createdDate":{
            "format":"date-time",
            "type":"string"
        },
        "territory":{
            "type":"string"
        },
        "stage":{
            "type":"string"
        },
        "totalOpportunityAmount":{
            "format":"double",
            "type":"number"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "primaryContactID":{
            "format":"int32",
            "type":"integer"
        },
        "crmCampaignID":{
            "type":"string"
        },
        "opportunityRevenues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OpportunityRevenue"
            }
        },
        "contact":{
            "$ref":"#/definitions/Contact"
        }
    }
}

Nested Schema : opportunityRevenues

Type: array

Show Source

• Array of: object OpportunityRevenue

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/OpportunityRevenue"
    }
}

Nested Schema : OpportunityRevenue

Type: object

Show Source

• attributedRevenue: number(double)
• eloquaCampaignID: integer(int32)
• influencedRevenue: number(double)
• lastModifiedDate: string(date-time)
• opportunity: object Opportunity
• opportunityID: integer(int32)

{
    "type":"object",
    "properties":{
        "eloquaCampaignID":{
            "format":"int32",
            "type":"integer"
        },
        "opportunityID":{
            "format":"int32",
            "type":"integer"
        },
        "attributedRevenue":{
            "format":"double",
            "type":"number"
        },
        "influencedRevenue":{
            "format":"double",
            "type":"number"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "opportunity":{
            "$ref":"#/definitions/Opportunity"
        }
    }
}

Back to Top