REST API for Oracle Account and Contact Enrichment

Get details for a company or contact

get

/api/v4/{objectType}/retrieve

This endpoint retrieves all available information for a given company/contact. The record requested must be defined by the DaaS Id of the company/contact.
Cost: When this function succeeds, the the user is charged; that is, usage is counted for the record returned.

The output is a JSON object that represents a company record that has been successfully retrieved. This record contains the same attributes as defined in the default export map. Alternately, you can specify a map name in your request.

Versions Supported:

v4

Request

Path Parameters

objectType: string

Mandatory. Must be company/contact

Query Parameters

id: string

Mandatory. DaaS ID of the record being requested
mapName: string

Optional. The name of the mapping that defines the attributes required in the output

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success

Root Schema : schema

Type: object

500 Response

An unexpected error occurred during the request.

Root Schema : schema

Type: object

Examples

Example Requests:

/api/v4/company/retrieve?id=BE0NDcwOTE5PywxASF=&mapName=SalesCloudCompanyExport_Release9 
/api/v4/contact/retrieve?id=BE0NDcwOTE5PywxASF=&mapName=SalesCloudContactExport_Release9 
/api/v4/company/retrieve?id=BE0NDcwOTE5PywxASF=&mapName=CXCompanyExport 
/api/v4/contact/retrieve?id=BE0NDcwOTE5PywxASF=&mapName=CXContactExport

Example Response:

{"attributes": [
        {"name": "Data/PartyOrigSystem", "value": "DAAS"},
        {"name": "Data/PartyOrigSystemReference", "value": "BE0NDcwOTE5PywxASF="},
        {"name": "Data/DataCloudStatus", "value": "ENRICHED"},
        {"name": "Data/OrganizationName", "value": "..."},
        {"name": "Data/CurrencyCode", "value": "..."},
        {"name": "Data/CurrFyPotentialRevenue", "value": "..."},
        {"name": "Data/DomesticUltimateDunsNumC", "value": "..."},
        {"name": "Data/DunsNumberC", "value": "..."},
        {"name": "Data/GlobalUltimateDunsNumC", "value": "..."},
        {"name": "Data/EmpAtPrimaryAdr", "value": "..."},
        {"name": "Data/EmpAtPrimaryAdrEstInd", "value": "N"},
        {"name": "Data/EmployeesTotal", "value": "..."},
        {"name": "Data/TotalEmpEstInd", "value": "N"},
        {"name": "Data/LegalStatusCode", "value": "..."},
        {"name": "Data/LineOfBusiness", "value": "..."},
        {"name": "Data/MinorityOwnedInd", "value": "N"},
        {"name": "Data/RentOwnInd", "value": "O"},
        {"name": "Data/PublicPrivateOwnershipFlag", "value": "N"},
        {"name": "Data/SmallBusInd", "value": "N"},
        {"name": "Data/StockSymbol", "value": "..."},
        {"name": "Data/ParentSubInd", "value": "N"},
        {"name": "Data/YearStarted", "value": "..."},
        {"name": "Data/LocationType", "value": "..."},
        {"name": "Data/FederalTaxIDNumber", "value": "..."},
        {"name": "Data/PrimaryAddressLine1", "value": "..."},
        {"name": "Data/PrimaryCity", "value": "..."},
        {"name": "Data/PrimaryCounty", "value": "..."},
        {"name": "Data/PrimaryState", "value": "..."},
        {"name": "Data/StateName", "value": "..."},
        {"name": "Data/PrimaryPostalCode", "value": "..."},
        {"name": "Data/PrimaryPostalPlus4Code", "value": "..."},
        {"name": "Data/PrimaryFullPostalCode", "value": "..."},
        {"name": "Data/PrimaryCountry", "value": "..."},
        {"name": "Data/Latitude", "value": "..."},
        {"name": "Data/LatitudeShort", "value": "..."},
        {"name": "Data/Longitude", "value": "..."},
        {"name": "Data/LongitudeShort", "value": "..."},
        {"name": "Data/PrimaryLocationOrigSystemReference", "value": "..."},
        {"name": "Data/PrimarySiteOrigSystemReference", "value": "..."},
        {"name": "Data/PhoneCountryCode", "value": "1"},
        {"name": "Data/RawPhoneNumber", "value": "..."},
        {"name": "Data/PhoneOrigSystemReference", "value": "..."},
        {"name": "Data/Url", "value": "www.oracle.com"},
        {"name": "Data/UrlOrigSystemReference", "value": "..."},
        {"name": "Data/WomanOwned", "value": "N"},
        {"name": "Data/AdditionalNameType1", "value": "..."},
        {"name": "Data/AdditionalName1", "value": "..."},
        {"name": "Data/MajorIndustryCategory", "value": "..."},
        {"name": "Data/MajorIndustryCategoryCode", "value": "..."},
        {"name": "Data/NAICSClassCategory1_1", "value": "..."},
        {"name": "Data/NAICSClassCode1_1", "value": "..."},
        {"name": "Data/NAICSClassCategory2_1", "value": "..."},
        {"name": "Data/NAICSClassCode2_1", "value": "..."},
        {"name": "Data/NAICSClassCategory3_1", "value": "..."},
        {"name": "Data/NAICSClassCode3_1", "value": "..."},
        {"name": "Data/NAICSClassCategory4_1", "value": "..."},
        {"name": "Data/NAICSClassCode4_1", "value": "..."},
        {"name": "Data/NAICSClassCategory5_1", "value": "..."},
        {"name": "Data/NAICSClassCode5_1", "value": "..."},
        {"name": "Data/SICClassCategory1", "value": "..."},
        {"name": "Data/SICClassCode1", "value": "..."},
        {"name": "Data/SICClassCategory2", "value": "..."},
        {"name": "Data/SICClassCode2", "value": "..."},
        {"name": "Data/SICClassCategory3", "value": "..."},
        {"name": "Data/SICClassCode3", "value": "..."},
        {"name": "Data/SICClassCategory4", "value": "..."},
        {"name": "Data/SICClassCode4", "value": "..."},
        {"name": "Data/SICClassCategory5", "value": "..."},
        {"name": "Data/SICClassCode5", "value": "..."},
        {"name": "Data/CompanyDescription", "value": "..."},
        {"name": "Data/MarketableIndicator", "value": "M"},
        {"name": "Data/GEOCodeAccuracy", "value": "D"},
        {"name": "Data/SalesVolume(USDollars)ReliabilityCode", "value": "0"},
        {"name": "Data/Sales Volume (US Dollars)", "value": "..."},
        {"name": "Data/DomesticUltimateBusinessName", "value": "..."},
        {"name": "Data/DomesticUltimateFIPSCountryCode", "value": "..."},
        {"name": "Data/DomesticUltimateD&BCountryCode", "value": "..."},
        {"name": "Data/DomesticUltimateState/ProvinceAbbreviation", "value": "..."},
        {"name": "Data/GlobalUltimateBusinessName", "value": "..."},
        {"name": "Data/GlobalUltimateIndicator", "value": "..."},
        {"name": "Data/GlobalUltimateFIPSCountryCode", "value": "..."},
        {"name": "Data/GlobalUltimateD&BCountryCode", "value": "..."},
        {"name": "Data/GlobalUltimateState/ProvinceAbbreviation", "value": "..."},
        {"name": "Data/HeadquarterDUNSNumber", "value": "..."},
        {"name": "Data/Parent/HeadquarterBusinessName", "value": "..."},
        {"name": "Data/HierarchyCode", "value": "..."},
        {"name": "Data/NumberofFamilyMembers", "value": "..."},
        {"name": "Data/OutofBusinessIndicator", "value": "..."},
        {"name": "Data/NYSEStockExchange", "value": "..."},
        {"name": "Data/OperatesFromResidenceIndicator", "value": "N"},
        {"name": "Data/PrimaryCompetitor1", "value": "..."},
        {"name": "Data/3YearGrowthPercentageonSalesVolume", "value": "..."},
        {"name": "Data/3YearGrowthPercentageonEmployees", "value": "..."},
        {"name": "Data/DelinquencyRisk", "value": "L"},
        {"name": "Data/CensusFIPSTerritoryCode", "value": "..."},
        {"name": "Data/CensusFIPSCountyCode", "value": "..."},
        {"name": "Data/PrimaryCompetitor2", "value": "..."},
        {"name": "Data/PrimaryCompetitor3", "value": "..."},
        {"name": "Data/SecondaryCompetitor1", "value": "..."},
        {"name": "Data/SecondaryCompetitor2", "value": "..."},
        {"name": "Data/GlobalExchangeName", "value": "..."},
        {"name": "Data/PrimaryIndicator", "value": "..."},
        {"name": "Data/FIPSMSACode", "value": "..."},
        {"name": "Data/ParentHeadquarterD&BCountryCode", "value": "..."},
        {"name": "Data/RecordStatus", "value": "N"},
        {"name": "Data/Maximum ARR(US Dollars)", "value": "..."},
        {"name": "Data/Max Employees", "value": "..."},
        {"name": "Data/Domestic Max ARR(USD)", "value": "..."},
        {"name": "Data/Domestic Max Employees", "value": "..."},
        {"name": "Data/ContactCount", "value": "..."}
        ]
}