AggKnowledge API

Company

Endpointhttps://api.aggknowledgeai.com

V2 APIs to fetch company information

Fetch company descriptions

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/descriptions

Accepts an array of AggK Company IDs and returns descriptions. If a description is not found and the company is ineligible for descriptions, an error flag is set. (Tier 4)

Fetch company descriptions › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Fetch company descriptions › Headers

x-api-key

string · required

API key for authentication

Fetch company descriptions › Request Body

Company description request

companyIds

integer[] · minItems: 1 · maxItems: 500 · required

List of AggK Company IDs to fetch descriptions for (max 500)

Fetch company descriptions › Responses

Company descriptions

object[]

List of company descriptions

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

Enrich

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/enrich

Accepts a company enrichment request and returns enriched company data (Tier 3)

Enrich › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Enrich › Headers

x-api-key

string · required

API key for authentication

Enrich › Request Body

Company enrichment request

companyId

integer · int64

Company ID

linkedinUrl

string

Company LinkedIn URL. This value will be normalized server-side.

linkedinUsername

string

Company LinkedIn username

object

Optional metadata to associate with the request. Will be returned in the response.

website

string

Company website

Enrich › Responses

Enriched company data

object

Complete company details including competitors and ultimate parent.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

POST/v2/{environment}/company/enrich

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/company/enrich \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "companyId": 15017574,
  "linkedinUrl": "https://www.linkedin.com/company/aggknowledge",
  "linkedinUsername": "aggknowledge",
  "metadata": {
    "key": "string"
  },
  "website": "aggknowledge.ai"
}
'

shell

Example Request Body

{
  "companyId": 15017574,
  "linkedinUrl": "https://www.linkedin.com/company/aggknowledge",
  "linkedinUsername": "aggknowledge",
  "metadata": {
    "key": "string"
  },
  "website": "aggknowledge.ai"
}

json

Example Responses

{
  "asyncOperations": {
    "isUpdatingCompetitors": true,
    "isUpdatingDescription": true,
    "isUpdatingProducts": true
  },
  "data": {
    "addressLine1": "100 wall st",
    "addressLine2": "suite 100",
    "city": "melville",
    "companyType": "private",
    "competitors": [
      {
        "companyId": 44510632,
        "competitiveDescription": "Patterson Companies is a medical supplies company that operates in the business of veterinary and dental products, competing with Henry Schein in the dental and veterinary supply markets.",
        "competitorName": "patterson dental"
      }
    ],
    "country": "united states",
    "description": "Henry Schein is a leading distributor of dental and medical supplies, founded in 1839. They offer a wide range of products including dental equipment, orthodontic devices, medical instruments, and pharmaceuticals. Their services include practice management solutions, equipment financing, and repair services to support healthcare professionals in managing their practices efficiently.",
    "displayName": "Henry Schein",
    "employeeCountActual": 9800,
    "employeeCountRange": "1-10",
    "fundingRoundCount": 1,
    "fundingTotal": "750000000.00",
    "id": 65731533,
    "industry": "accounting",
    "isDescriptionReviewedByHuman": true,
    "isStructuredEntity": true,
    "latestFundingAmount": "1000000.00",
    "latestFundingDate": "2023-08-08",
    "latestFundingStage": "angel",
    "linkedinId": 93061732,
    "linkedinUrl": "linkedin.com/company/henry-schein",
    "name": "henry schein",
    "pdlCompanyId": "CBczqSDnKU3LGFyDe3JeoA9IhxYi",
    "postalCode": "11747",
    "primaryExchange": "xnas",
    "primaryTicker": "HSIC",
    "productsAndServices": [
      {
        "categories": [
          {
            "categoryHierarchy": [
              {
                "categoryId": 137,
                "level": 4,
                "name": "Procurement"
              }
            ],
            "id": 1785,
            "name": "Accounts Payable (AP) and Spend Analysis"
          }
        ],
        "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
        "id": 60436221725246776,
        "name": "Coupa",
        "vendorAggkCompanyId": 42971468
      }
    ],
    "revenueRangeInferred": "$0-$1M",
    "stateOrProvince": "new york",
    "technographics": [
      {
        "description": "description",
        "indications": {
          "jobOpeningsCount": 0,
          "reviewsCount": 0,
          "webDetectionCount": 0
        },
        "lastObservation": "2024-08-25",
        "productId": 0,
        "productName": "productName",
        "vendorId": 0
      }
    ],
    "ultimateParent": {
      "addressLine1": "100 wall st",
      "addressLine2": "suite 100",
      "city": "melville",
      "companyType": "private",
      "country": "united states",
      "description": "Henry Schein is a leading distributor of dental and medical supplies, founded in 1839. They offer a wide range of products including dental equipment, orthodontic devices, medical instruments, and pharmaceuticals. Their services include practice management solutions, equipment financing, and repair services to support healthcare professionals in managing their practices efficiently.",
      "displayName": "Henry Schein",
      "employeeCountActual": 9800,
      "employeeCountRange": "1-10",
      "fundingRoundCount": 1,
      "fundingTotal": "750000000.00",
      "id": 65731533,
      "industry": "accounting",
      "isDescriptionReviewedByHuman": true,
      "isStructuredEntity": true,
      "latestFundingAmount": "1000000.00",
      "latestFundingDate": "2023-08-08",
      "latestFundingStage": "angel",
      "linkedinId": 93061732,
      "linkedinUrl": "linkedin.com/company/henry-schein",
      "name": "henry schein",
      "pdlCompanyId": "CBczqSDnKU3LGFyDe3JeoA9IhxYi",
      "postalCode": "11747",
      "primaryExchange": "xnas",
      "primaryTicker": "HSIC",
      "revenueRangeInferred": "$0-$1M",
      "stateOrProvince": "new york",
      "wasDescriptionRejected": false,
      "website": "henryschein.com",
      "willDescriptionBeGenerated": true
    },
    "wasDescriptionRejected": false,
    "website": "henryschein.com",
    "willDescriptionBeGenerated": true
  },
  "inputParameters": {
    "companyId": 15017574,
    "linkedinUrl": "https://www.linkedin.com/company/aggknowledge",
    "linkedinUsername": "aggknowledge",
    "website": "aggknowledge.ai"
  },
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  }
}

json

application/json

Bulk enrich

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/enrich/bulk

Accepts a list of company enrichment request and returns a list of enriched company data (Tier 3)

Bulk enrich › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Bulk enrich › Headers

x-api-key

string · required

API key for authentication

Bulk enrich › Request Body

Company enrichment request

object[]

Bulk enrich › Responses

Enriched company data

object[]

object

Complete company details including competitors and ultimate parent.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

POST/v2/{environment}/company/enrich/bulk

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/company/enrich/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "requests": [
    {
      "companyId": 15017574,
      "linkedinUrl": "https://www.linkedin.com/company/aggknowledge",
      "linkedinUsername": "aggknowledge",
      "metadata": {
        "key": "string"
      },
      "website": "aggknowledge.ai"
    }
  ]
}
'

shell

Example Request Body

{
  "requests": [
    {
      "companyId": 15017574,
      "linkedinUrl": "https://www.linkedin.com/company/aggknowledge",
      "linkedinUsername": "aggknowledge",
      "metadata": {
        "key": "string"
      },
      "website": "aggknowledge.ai"
    }
  ]
}

json

Example Responses

[
  {
    "asyncOperations": {
      "isUpdatingCompetitors": true,
      "isUpdatingDescription": true,
      "isUpdatingProducts": true
    },
    "data": {
      "addressLine1": "100 wall st",
      "addressLine2": "suite 100",
      "city": "melville",
      "companyType": "private",
      "competitors": [
        {
          "companyId": 44510632,
          "competitiveDescription": "Patterson Companies is a medical supplies company that operates in the business of veterinary and dental products, competing with Henry Schein in the dental and veterinary supply markets.",
          "competitorName": "patterson dental"
        }
      ],
      "country": "united states",
      "description": "Henry Schein is a leading distributor of dental and medical supplies, founded in 1839. They offer a wide range of products including dental equipment, orthodontic devices, medical instruments, and pharmaceuticals. Their services include practice management solutions, equipment financing, and repair services to support healthcare professionals in managing their practices efficiently.",
      "displayName": "Henry Schein",
      "employeeCountActual": 9800,
      "employeeCountRange": "1-10",
      "fundingRoundCount": 1,
      "fundingTotal": "750000000.00",
      "id": 65731533,
      "industry": "accounting",
      "isDescriptionReviewedByHuman": true,
      "isStructuredEntity": true,
      "latestFundingAmount": "1000000.00",
      "latestFundingDate": "2023-08-08",
      "latestFundingStage": "angel",
      "linkedinId": 93061732,
      "linkedinUrl": "linkedin.com/company/henry-schein",
      "name": "henry schein",
      "pdlCompanyId": "CBczqSDnKU3LGFyDe3JeoA9IhxYi",
      "postalCode": "11747",
      "primaryExchange": "xnas",
      "primaryTicker": "HSIC",
      "productsAndServices": [
        {
          "categories": [
            {
              "categoryHierarchy": [
                {
                  "categoryId": 137,
                  "level": 4,
                  "name": "Procurement"
                }
              ],
              "id": 1785,
              "name": "Accounts Payable (AP) and Spend Analysis"
            }
          ],
          "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
          "id": 60436221725246776,
          "name": "Coupa",
          "vendorAggkCompanyId": 42971468
        }
      ],
      "revenueRangeInferred": "$0-$1M",
      "stateOrProvince": "new york",
      "technographics": [
        {
          "description": "description",
          "indications": {
            "jobOpeningsCount": 0,
            "reviewsCount": 0,
            "webDetectionCount": 0
          },
          "lastObservation": "2024-08-25",
          "productId": 0,
          "productName": "productName",
          "vendorId": 0
        }
      ],
      "ultimateParent": {
        "addressLine1": "100 wall st",
        "addressLine2": "suite 100",
        "city": "melville",
        "companyType": "private",
        "country": "united states",
        "description": "Henry Schein is a leading distributor of dental and medical supplies, founded in 1839. They offer a wide range of products including dental equipment, orthodontic devices, medical instruments, and pharmaceuticals. Their services include practice management solutions, equipment financing, and repair services to support healthcare professionals in managing their practices efficiently.",
        "displayName": "Henry Schein",
        "employeeCountActual": 9800,
        "employeeCountRange": "1-10",
        "fundingRoundCount": 1,
        "fundingTotal": "750000000.00",
        "id": 65731533,
        "industry": "accounting",
        "isDescriptionReviewedByHuman": true,
        "isStructuredEntity": true,
        "latestFundingAmount": "1000000.00",
        "latestFundingDate": "2023-08-08",
        "latestFundingStage": "angel",
        "linkedinId": 93061732,
        "linkedinUrl": "linkedin.com/company/henry-schein",
        "name": "henry schein",
        "pdlCompanyId": "CBczqSDnKU3LGFyDe3JeoA9IhxYi",
        "postalCode": "11747",
        "primaryExchange": "xnas",
        "primaryTicker": "HSIC",
        "revenueRangeInferred": "$0-$1M",
        "stateOrProvince": "new york",
        "wasDescriptionRejected": false,
        "website": "henryschein.com",
        "willDescriptionBeGenerated": true
      },
      "wasDescriptionRejected": false,
      "website": "henryschein.com",
      "willDescriptionBeGenerated": true
    },
    "inputParameters": {
      "companyId": 15017574,
      "linkedinUrl": "https://www.linkedin.com/company/aggknowledge",
      "linkedinUsername": "aggknowledge",
      "website": "aggknowledge.ai"
    },
    "isRetryable": true,
    "isSuccess": true,
    "metadata": {
      "key": "string"
    }
  }
]

json

application/json

Match

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/match

Accepts company attributes and returns matching companies (Tier 3)

Match › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Match › Headers

x-api-key

string · required

API key for authentication

Match › Request Body

Company match request

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Range filter with min/max integer values

object

Range filter with min/max long values

object

Filter with or/not semantics

object

Range filter with min/max long values

object

Range filter with gte/lte date values

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

Match › Responses

Company match results

object[]

POST/v2/{environment}/company/match

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/company/match \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "companyType": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "country": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "employeeCountRange": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "fundingRoundCount": {
    "max": 0,
    "min": 0
  },
  "fundingTotal": {
    "max": 0,
    "min": 0
  },
  "industry": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "latestFundingAmount": {
    "max": 0,
    "min": 0
  },
  "latestFundingDate": {
    "gte": "gte",
    "lte": "lte"
  },
  "latestFundingStage": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "locality": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "name": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "primaryExchange": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "primaryTicker": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "region": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "revenueRangeInferred": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "socialProfile": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "website": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  }
}
'

shell

Example Request Body

{
  "companyType": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "country": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "employeeCountRange": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "fundingRoundCount": {
    "max": 0,
    "min": 0
  },
  "fundingTotal": {
    "max": 0,
    "min": 0
  },
  "industry": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "latestFundingAmount": {
    "max": 0,
    "min": 0
  },
  "latestFundingDate": {
    "gte": "gte",
    "lte": "lte"
  },
  "latestFundingStage": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "locality": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "name": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "primaryExchange": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "primaryTicker": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "region": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "revenueRangeInferred": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "socialProfile": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  },
  "website": {
    "and": [
      "string"
    ],
    "not": [
      "string"
    ],
    "or": [
      "string"
    ]
  }
}

json

Example Responses

{
  "results": [
    {
      "displayName": "displayName",
      "id": 0,
      "linkedinUrl": "linkedinUrl",
      "name": "name",
      "website": "website"
    }
  ]
}

json

application/json

Search

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/search

Accepts a company search request and returns possible matches (Tier 3)

Search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Search › Headers

x-api-key

string · required

API key for authentication

Search › Request Body

Company search request

companyName

string

Company name

Search › Responses

Company search results

object[]

Product Catalog Normalization

Fetch company descriptions

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/descriptions

Accepts an array of AggK Company IDs and returns descriptions. If a description is not found and the company is ineligible for descriptions, an error flag is set. (Tier 4)

Fetch company descriptions › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Fetch company descriptions › Headers

x-api-key

string · required

API key for authentication

Fetch company descriptions › Request Body

Company description request

companyIds

integer[] · minItems: 1 · maxItems: 500 · required

List of AggK Company IDs to fetch descriptions for (max 500)

Fetch company descriptions › Responses

Company descriptions

object[]

List of company descriptions

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

Enrich

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/enrich

Accepts a company enrichment request and returns enriched company data (Tier 3)

Enrich › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Enrich › Headers

x-api-key

string · required

API key for authentication

Enrich › Request Body

Company enrichment request

companyId

integer · int64

Company ID

linkedinUrl

string

Company LinkedIn URL. This value will be normalized server-side.

linkedinUsername

string

Company LinkedIn username

object

Optional metadata to associate with the request. Will be returned in the response.

website

string

Company website

Enrich › Responses

Enriched company data

object

Complete company details including competitors and ultimate parent.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

Bulk enrich

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/enrich/bulk

Accepts a list of company enrichment request and returns a list of enriched company data (Tier 3)

Bulk enrich › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Bulk enrich › Headers

x-api-key

string · required

API key for authentication

Bulk enrich › Request Body

Company enrichment request

object[]

Bulk enrich › Responses

Enriched company data

object[]

object

Complete company details including competitors and ultimate parent.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

Match

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/match

Accepts company attributes and returns matching companies (Tier 3)

Match › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Match › Headers

x-api-key

string · required

API key for authentication

Match › Request Body

Company match request

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Range filter with min/max integer values

object

Range filter with min/max long values

object

Filter with or/not semantics

object

Range filter with min/max long values

object

Range filter with gte/lte date values

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

object

Filter with or/not semantics

Match › Responses

Company match results

object[]

POST

https://api.aggknowledgeai.com

/v2/{environment}/company/search

Accepts a company search request and returns possible matches (Tier 3)

Search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Search › Headers

x-api-key

string · required

API key for authentication

Search › Request Body

Company search request

companyName

string

Company name

Search › Responses

Company search results

object[]