Skip to main content
POST
geo.business.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by geo.businesses.search or geo.address.businesses.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
include
enum<string>[]

Only these detail facts.

Required array length: 1 - 300 elements
Available options:
accountingExpenseRange,
accountingExpenseTotal,
advertisingExpenseRange,
advertisingExpenseTotal,
businessInsuranceExpenseRange,
businessInsuranceExpenseTotal,
businessStatus,
businessType,
carrierRoute,
censusBlock,
censusTract,
cityName,
companyName,
companyNameSecondary,
contactFirstName,
contactFullName,
contactGender,
contactLastName,
contactMiddleName,
contactPrefix,
contactProfessionalTitle,
contactSuffix,
coreBasedStatAreaCode,
coreBasedStatAreaName,
corporateEmployeeCountRange,
corporateEmployeeCountTotal,
countyFips,
countyName,
creditCapacity,
creditCapacityRange,
creditScore,
creditScoreDescription,
dateOfLastUpdate,
deliveryLine1,
deliveryPoint,
deliveryPointCheckDigit,
domesticForeignOwnerIndicator,
ein,
email,
emailAvailableIndicator,
executiveDepartment,
executiveLevel,
executiveVerificationType,
fax,
femaleOwnedIndicator,
foreignParentCityName,
foreignParentCompanyName,
foreignParentCountry,
fortune1000Branches,
fortune1000Indicator,
fortune1000Rank,
holdingCityName,
holdingCompanyName,
holdingStateAbbreviation,
homeBasedBusinessIndicator,
hqCityName,
hqCompanyName,
hqNumberOfCompanies,
hqStateAbbreviation,
latitude,
legalExpenseRange,
legalExpenseTotal,
linkageCompanyName,
linkageIndicator,
linkageLevel,
linkageType,
locationEmployeeCount,
locationEmployeeCountRange,
locationSalesRange,
locationSalesTotal,
longitude,
mailScoreCode,
mailScoreDescription,
mailingCarrierRoute,
mailingCityName,
mailingDeliveryLine1,
mailingDeliveryPoint,
mailingDeliveryPointCheckDigit,
mailingPlus4Code,
mailingStateAbbreviation,
mailingZipcode,
manufacturingIndicator,
minorityOwnedIndicator,
minorityType,
naics01Code,
naics01Description,
naics02Code,
naics02Description,
naics03Code,
naics03Description,
naics04Code,
naics04Description,
naics05Code,
naics05Description,
naics06Code,
naics06Description,
newBusinessIndicator,
nonProfitIndicator,
numOfPcsRange,
numOfPcsTotal,
numberOfYearsInBusiness,
numberOfYearsInBusinessRange,
officeEquipmentExpenseRange,
officeEquipmentExpenseTotal,
operatingHoursFriday,
operatingHoursMonday,
operatingHoursSaturday,
operatingHoursSunday,
operatingHoursThursday,
operatingHoursTuesday,
operatingHoursWednesday,
phone,
phoneAreaCode,
phoneSecondary,
phoneTollFree,
plus4Code,
populationRange,
precision,
primaryExecutiveIndicator,
primaryNumber,
primarySic2digitCode,
primarySic2digitDescription,
primarySic4digitCode,
primarySic4digitDescription,
primarySicCode,
primarySicDescription,
publicIndicator,
rdi,
rentExpenseRange,
rentExpenseTotal,
secondary01Sic7digitCode,
secondary01Sic7digitDescription,
secondary02Sic7digitCode,
secondary02Sic7digitDescription,
secondary03Sic7digitCode,
secondary03Sic7digitDescription,
secondary04Sic7digitCode,
secondary04Sic7digitDescription,
secondary05Sic7digitCode,
secondary05Sic7digitDescription,
secondaryDesignator,
secondaryNumber,
sectionalCenterFacility,
smallBusinessIndicator,
sourceTitle,
squareFootage,
squareFootageRange,
standardizedTitle,
standardizedTitleRank,
stateAbbreviation,
stockExchange,
streetName,
streetPostdirection,
streetPredirection,
streetSuffix,
subHqCityName,
subHqCompanyName,
subHqNumberOfCompanies,
subHqStateAbbreviation,
technologyExpenseRange,
technologyExpenseTotal,
telecomExpenseRange,
telecomExpenseTotal,
tickerSymbol,
timeZone,
url,
urlFacebook,
urlInstagram,
urlLinkedin,
urlTwitter,
urlYelp,
urlYoutube,
utilitiesExpenseRange,
utilitiesExpenseTotal,
webmailIndicator,
yearCurrent,
yearCurrentEmployeeCount,
yearEstablished,
yearFourPrior,
yearFourPriorEmployeeCount,
yearFourPriorEmployeeGrowth,
yearOnePrior,
yearOnePriorEmployeeCount,
yearOnePriorEmployeeGrowth,
yearThreePrior,
yearThreePriorEmployeeCount,
yearThreePriorEmployeeGrowth,
yearTwoPrior,
yearTwoPriorEmployeeCount,
yearTwoPriorEmployeeGrowth,
zipcode
exclude
enum<string>[]

Omit these detail facts.

Required array length: 1 - 300 elements
Available options:
accountingExpenseRange,
accountingExpenseTotal,
advertisingExpenseRange,
advertisingExpenseTotal,
businessInsuranceExpenseRange,
businessInsuranceExpenseTotal,
businessStatus,
businessType,
carrierRoute,
censusBlock,
censusTract,
cityName,
companyName,
companyNameSecondary,
contactFirstName,
contactFullName,
contactGender,
contactLastName,
contactMiddleName,
contactPrefix,
contactProfessionalTitle,
contactSuffix,
coreBasedStatAreaCode,
coreBasedStatAreaName,
corporateEmployeeCountRange,
corporateEmployeeCountTotal,
countyFips,
countyName,
creditCapacity,
creditCapacityRange,
creditScore,
creditScoreDescription,
dateOfLastUpdate,
deliveryLine1,
deliveryPoint,
deliveryPointCheckDigit,
domesticForeignOwnerIndicator,
ein,
email,
emailAvailableIndicator,
executiveDepartment,
executiveLevel,
executiveVerificationType,
fax,
femaleOwnedIndicator,
foreignParentCityName,
foreignParentCompanyName,
foreignParentCountry,
fortune1000Branches,
fortune1000Indicator,
fortune1000Rank,
holdingCityName,
holdingCompanyName,
holdingStateAbbreviation,
homeBasedBusinessIndicator,
hqCityName,
hqCompanyName,
hqNumberOfCompanies,
hqStateAbbreviation,
latitude,
legalExpenseRange,
legalExpenseTotal,
linkageCompanyName,
linkageIndicator,
linkageLevel,
linkageType,
locationEmployeeCount,
locationEmployeeCountRange,
locationSalesRange,
locationSalesTotal,
longitude,
mailScoreCode,
mailScoreDescription,
mailingCarrierRoute,
mailingCityName,
mailingDeliveryLine1,
mailingDeliveryPoint,
mailingDeliveryPointCheckDigit,
mailingPlus4Code,
mailingStateAbbreviation,
mailingZipcode,
manufacturingIndicator,
minorityOwnedIndicator,
minorityType,
naics01Code,
naics01Description,
naics02Code,
naics02Description,
naics03Code,
naics03Description,
naics04Code,
naics04Description,
naics05Code,
naics05Description,
naics06Code,
naics06Description,
newBusinessIndicator,
nonProfitIndicator,
numOfPcsRange,
numOfPcsTotal,
numberOfYearsInBusiness,
numberOfYearsInBusinessRange,
officeEquipmentExpenseRange,
officeEquipmentExpenseTotal,
operatingHoursFriday,
operatingHoursMonday,
operatingHoursSaturday,
operatingHoursSunday,
operatingHoursThursday,
operatingHoursTuesday,
operatingHoursWednesday,
phone,
phoneAreaCode,
phoneSecondary,
phoneTollFree,
plus4Code,
populationRange,
precision,
primaryExecutiveIndicator,
primaryNumber,
primarySic2digitCode,
primarySic2digitDescription,
primarySic4digitCode,
primarySic4digitDescription,
primarySicCode,
primarySicDescription,
publicIndicator,
rdi,
rentExpenseRange,
rentExpenseTotal,
secondary01Sic7digitCode,
secondary01Sic7digitDescription,
secondary02Sic7digitCode,
secondary02Sic7digitDescription,
secondary03Sic7digitCode,
secondary03Sic7digitDescription,
secondary04Sic7digitCode,
secondary04Sic7digitDescription,
secondary05Sic7digitCode,
secondary05Sic7digitDescription,
secondaryDesignator,
secondaryNumber,
sectionalCenterFacility,
smallBusinessIndicator,
sourceTitle,
squareFootage,
squareFootageRange,
standardizedTitle,
standardizedTitleRank,
stateAbbreviation,
stockExchange,
streetName,
streetPostdirection,
streetPredirection,
streetSuffix,
subHqCityName,
subHqCompanyName,
subHqNumberOfCompanies,
subHqStateAbbreviation,
technologyExpenseRange,
technologyExpenseTotal,
telecomExpenseRange,
telecomExpenseTotal,
tickerSymbol,
timeZone,
url,
urlFacebook,
urlInstagram,
urlLinkedin,
urlTwitter,
urlYelp,
urlYoutube,
utilitiesExpenseRange,
utilitiesExpenseTotal,
webmailIndicator,
yearCurrent,
yearCurrentEmployeeCount,
yearEstablished,
yearFourPrior,
yearFourPriorEmployeeCount,
yearFourPriorEmployeeGrowth,
yearOnePrior,
yearOnePriorEmployeeCount,
yearOnePriorEmployeeGrowth,
yearThreePrior,
yearThreePriorEmployeeCount,
yearThreePriorEmployeeGrowth,
yearTwoPrior,
yearTwoPriorEmployeeCount,
yearTwoPriorEmployeeGrowth,
zipcode

Response

The result

modified
boolean
required

False if unchanged.

record
object
required

Updated detail handle.

business
object