Entitlements
An entitlement is a data product your contract includes, and your key can call only the endpoints it covers. Every endpoint declares the entitlement it needs; its reference page shows the badge next to the rate limit tier.
A call to an endpoint your contract does not include is rejected with 402 Payment Required (“Feature not enabled”) — it is not billed and does not consume credits. To add an entitlement, contact your AggKnowledge account team.
Entitlements are independent of rate limit tiers and of credits: an entitlement decides whether you may call an endpoint, a tier decides how often, and credits reflect whether a call returned data.
or. For contact info the entitlement you hold also decides which fields you may request: asking for a field your contract does not include is rejected even though the call itself is allowed.Entitlements and the endpoints they unlock#
Person Enrichment#
Enrich, match and validate people, synchronously or in bulk.
POST /v2/{environment}/person/enrichPOST /v2/{environment}/person/validatePOST /v2/{environment}/person/validate/bulkPOST /v2/{environment}/person/enrich/bulkGET /v2/{environment}/person/enrich/bulk/listGET /v2/{environment}/person/enrich/bulk/{id}GET /v2/{environment}/person/enrich/bulk/{id}/item/{itemId}GET /v2/{environment}/person/enrich/bulk/{id}/itemsPOST /v3/{environment}/person/asynchronous/enrichGET /v3/{environment}/person/asynchronous/enrich/{id}POST /v3/{environment}/person/synchronous/enrichPOST /v3/{environment}/person/synchronous/validate
Person Search#
Search and match people without returning an enriched profile.
Company Enrichment#
Enrich companies and fetch company descriptions.
Company Search#
Search and match companies without returning an enriched profile.
Company Headcount#
Historical headcount timeseries for a company.
Company Relationships#
Vendor and customer relationships between companies.
Discover#
Discover people by filter, including counts and request validation.
POST /v2/{environment}/discover/peoplePOST /v2/{environment}/discover/people/countPOST /v2/{environment}/discover/people/validatePOST /v2/{environment}/discover/people/advancedPOST /v2/{environment}/discover/people/advanced/countPOST /v2/{environment}/discover/people/advanced/validatePOST /v2/{environment}/discover/people/advanced/translatePOST /v3/{environment}/discover/peoplePOST /v3/{environment}/discover/people/countPOST /v3/{environment}/discover/people/validate
Discover Sidekick#
Natural-language search over Discover.
Person Vendorgraphics#
Products a person uses in their role, and the product catalog behind it.
GET /v2/{environment}/vendorgraphics/categoriesGET /v2/{environment}/vendorgraphics/productsPOST /v2/{environment}/vendorgraphics/search/productsPOST /v2/{environment}/vendorgraphics/personGET /v3/{environment}/vendorgraphics/product-catalog/categoriesGET /v3/{environment}/vendorgraphics/product-catalog/productsPOST /v3/{environment}/vendorgraphics/product-catalog/products/find
Company Vendorgraphics#
Products a company uses, customer search by product or category, and the product catalog behind it.
GET /v2/{environment}/vendorgraphics/categoriesGET /v2/{environment}/vendorgraphics/productsPOST /v2/{environment}/vendorgraphics/search/productsPOST /v2/{environment}/vendorgraphics/companyPOST /v2/{environment}/vendorgraphics/search/customers/by-categoryPOST /v2/{environment}/vendorgraphics/search/customers/by-productPOST /v3/{environment}/company/products-usedPOST /v3/{environment}/vendorgraphics/customers/by-productPOST /v3/{environment}/vendorgraphics/customers/by-categoryGET /v3/{environment}/vendorgraphics/product-catalog/categoriesGET /v3/{environment}/vendorgraphics/product-catalog/productsPOST /v3/{environment}/vendorgraphics/product-catalog/products/find
Work Email#
Request work email addresses through the contact-info endpoints.
Personal Email#
Request personal email addresses through the contact-info endpoints.
Phone#
Request phone numbers through the contact-info endpoints.
Healthcare (HCP)#
Healthcare provider match and enrichment, and drugs.
POST /v3/{environment}/healthcare/hcp/matchGET /v3/{environment}/healthcare/hcp/{aggkHcpId}POST /v3/{environment}/healthcare/hcp/{aggkHcpId}/conditions-investigatedPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/conditions-treatedPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/congressesPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/diagnosesPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/drugs-investigatedPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/drugs-prescribedPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/prescriptionsPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/proceduresPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/procedures-performedPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/publicationsPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/research-topicsPOST /v3/{environment}/healthcare/hcp/{aggkHcpId}/trialsPOST /v3/{environment}/healthcare/drugs/matchGET /v3/{environment}/healthcare/drugs/{ndc}
Healthcare contact#
Contact details for a healthcare professional by aggkHcpId. Billed per professional per period, not per lookup.
Healthcare (HCO)#
Healthcare organization match and enrichment.
Endpoints that need no entitlement#
These endpoints are callable with any valid API key — normalization helpers, account introspection, and webhook configuration.
GET /v2/{environment}/me/rate-limitsPOST /v2/{environment}/normalization/job-titlePOST /v2/{environment}/normalization/linkedin-urlPOST /v2/{environment}/normalization/linkedin-usernamePOST /v2/{environment}/normalization/websiteGET /v2/{environment}/usageGET /v3/{environment}/healthcare/taxonomies/{taxonomyId}GET /v3/{environment}/me/rate-limitsGET /v3/{environment}/me/usageGET /v3/{environment}/webhooks/destinationsPOST /v3/{environment}/webhooks/destinationsDELETE /v3/{environment}/webhooks/destinations/{id}GET /v3/{environment}/webhooks/hmac-keysPOST /v3/{environment}/webhooks/hmac-keysDELETE /v3/{environment}/webhooks/hmac-keys/{id}GET /v3/{environment}/listsPOST /v3/{environment}/listsGET /v3/{environment}/lists/{id}PATCH /v3/{environment}/lists/{id}DELETE /v3/{environment}/lists/{id}GET /v3/{environment}/lists/{id}/membersPOST /v3/{environment}/lists/{id}/membersDELETE /v3/{environment}/lists/{id}/members