AggKnowledge API

Person Asynchronous

Endpointhttps://api.aggknowledgeai.com

V2 asynchronous APIs to fetch person information

Bulk enrich

POST

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk

Accepts a list of person enrichment requests and returns a batch ID (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

object[]

Person enrichment request

object

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

pdlId

string

The person's PDL ID.

personId

integer · int64

The AggKnowledge person ID.

professionalSocialMediaUrl

string

LinkedIn URL of the person. Protocol and subdomain are optional, this value will be normalized server-side. Sales Nav and Recruiter URLs are allowed.

Bulk enrich › Responses

Enriched person data

batchId

string

The batch ID of the bulk enrichment request. Use this to check the status of the request and fetch the data.

List all person bulk enrichment batches

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/list

Returns all person bulk enrichment batches for the current customer (Tier 4)

List all person bulk enrichment batches › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

List all person bulk enrichment batches › query Parameters

createdAfter

string

Filter batches created after this date (YYYY-MM-DD format)

limit

integer · int32

Maximum number of results to return (default: 100, max: 1000)

Default: 100

offset

integer · int32

Number of results to skip for pagination (default: 0)

Default: 0

List all person bulk enrichment batches › Headers

x-api-key

string · required

API key for authentication

List all person bulk enrichment batches › Responses

List of person bulk enrichment batches

object[]

List of person bulk enrichment batches

Bulk enrichment status

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/{id}

Returns the status of a bulk enrichment (Tier 4)

Bulk enrichment status › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Bulk enrichment ID

Bulk enrichment status › Headers

x-api-key

string · required

API key for authentication

Bulk enrichment status › Responses

Bulk enrichment status

object[]

status

string · enum

Enum values:

ready

pending

purged

Fetch bulk enriched person

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/{id}/item/{itemId}

Returns a complete bulk enriched person (Tier 4)

Fetch bulk enriched person › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Bulk enrichment ID

itemId

string · required

Bulk enrichment item ID

Fetch bulk enriched person › Headers

x-api-key

string · required

API key for authentication

Fetch bulk enriched person › Responses

Bulk enrichment status

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

object

GET/v2/{environment}/person/enrich/bulk/{id}/item/{itemId}

curl --request GET \
  --url https://api.aggknowledgeai.com/v2/:environment/person/enrich/bulk/:id/item/:itemId \
  --header 'x-api-key: <string>'

shell

Example Responses

{
  "data": {
    "bio": "bio",
    "dateLastUpdated": "2025-02",
    "firstName": "daniel",
    "id": 590654273,
    "lastName": "entrup",
    "linkedinUrl": "linkedin.com/in/danielentrup",
    "linkedinUsername": "danielentrup",
    "locationCity": "new york",
    "locationCountry": "united states",
    "locationMetro": "new york, new york",
    "locationPostalCode": "10001",
    "locationStateOrProvince": "new york",
    "middleName": "middleName",
    "primaryWorkExperienceId": 935242012,
    "tags": [
      {
        "confidenceLevel": 0,
        "description": "description",
        "name": "Java",
        "relatedWorkExperiences": [
          {
            "companyName": "Google",
            "jobRole": "operations",
            "jobSubRole": "executive",
            "jobTitle": "senior software engineer",
            "workExperienceId": 0
          }
        ],
        "type": 0
      }
    ],
    "workExperience": [
      {
        "company": {
          "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
        },
        "description": "description",
        "endDate": "2023-11",
        "id": 862384084,
        "jobClass": "general_and_administrative",
        "role": {
          "v1": "operations",
          "v2": "operations"
        },
        "seniority": "cxo",
        "startDate": "2023-02",
        "subrole": {
          "v1": "data",
          "v2": "executive"
        },
        "title": "chief executive officer",
        "titleRaw": "ceo"
      }
    ]
  },
  "inputParameters": {
    "pdlId": "pdlId",
    "personId": 590654273,
    "professionalSocialMediaUrl": "https://www.linkedin.com/in/danielentrup/"
  },
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  },
  "problems": {
    "linkedinProfileNotFound": true,
    "transientScrapingVendorFailure": true
  }
}

json

application/json

Get all person bulk enrichment items

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/{id}/items

Returns all enriched person items for a batch with cursor-based pagination (Tier 4)

Get all person bulk enrichment items › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Bulk enrichment batch ID

Get all person bulk enrichment items › query Parameters

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

limit

integer · int32

Maximum number of results to return (default: 20, max: 50)

Default: 20

Get all person bulk enrichment items › Headers

x-api-key

string · required

API key for authentication

Get all person bulk enrichment items › Responses

List of enriched person items with pagination

Response containing bulk enrichment items with pagination

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

object[]

List of enriched person data

GET/v2/{environment}/person/enrich/bulk/{id}/items

curl --request GET \
  --url https://api.aggknowledgeai.com/v2/:environment/person/enrich/bulk/:id/items \
  --header 'x-api-key: <string>'

shell

Example Responses

{
  "cursor": "cursor",
  "items": [
    {
      "data": {
        "bio": "bio",
        "dateLastUpdated": "2025-02",
        "firstName": "daniel",
        "id": 590654273,
        "lastName": "entrup",
        "linkedinUrl": "linkedin.com/in/danielentrup",
        "linkedinUsername": "danielentrup",
        "locationCity": "new york",
        "locationCountry": "united states",
        "locationMetro": "new york, new york",
        "locationPostalCode": "10001",
        "locationStateOrProvince": "new york",
        "middleName": "middleName",
        "primaryWorkExperienceId": 935242012,
        "tags": [
          {
            "confidenceLevel": 0,
            "description": "description",
            "name": "Java",
            "relatedWorkExperiences": [
              {
                "companyName": "Google",
                "jobRole": "operations",
                "jobSubRole": "executive",
                "jobTitle": "senior software engineer",
                "workExperienceId": 0
              }
            ],
            "type": 0
          }
        ],
        "workExperience": [
          {
            "company": {
              "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
            },
            "description": "description",
            "endDate": "2023-11",
            "id": 862384084,
            "jobClass": "general_and_administrative",
            "role": {
              "v1": "operations",
              "v2": "operations"
            },
            "seniority": "cxo",
            "startDate": "2023-02",
            "subrole": {
              "v1": "data",
              "v2": "executive"
            },
            "title": "chief executive officer",
            "titleRaw": "ceo"
          }
        ]
      },
      "inputParameters": {
        "pdlId": "pdlId",
        "personId": 590654273,
        "professionalSocialMediaUrl": "https://www.linkedin.com/in/danielentrup/"
      },
      "isRetryable": true,
      "isSuccess": true,
      "metadata": {
        "key": "string"
      },
      "problems": {
        "linkedinProfileNotFound": true,
        "transientScrapingVendorFailure": true
      }
    }
  ]
}

json

application/json

Person Synchronous Contact Info

Bulk enrich

POST

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk

Accepts a list of person enrichment requests and returns a batch ID (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

object[]

Person enrichment request

object

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

pdlId

string

The person's PDL ID.

personId

integer · int64

The AggKnowledge person ID.

professionalSocialMediaUrl

string

LinkedIn URL of the person. Protocol and subdomain are optional, this value will be normalized server-side. Sales Nav and Recruiter URLs are allowed.

Bulk enrich › Responses

Enriched person data

batchId

string

The batch ID of the bulk enrichment request. Use this to check the status of the request and fetch the data.

List all person bulk enrichment batches

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/list

Returns all person bulk enrichment batches for the current customer (Tier 4)

List all person bulk enrichment batches › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

List all person bulk enrichment batches › query Parameters

createdAfter

string

Filter batches created after this date (YYYY-MM-DD format)

limit

integer · int32

Maximum number of results to return (default: 100, max: 1000)

Default: 100

offset

integer · int32

Number of results to skip for pagination (default: 0)

Default: 0

List all person bulk enrichment batches › Headers

x-api-key

string · required

API key for authentication

List all person bulk enrichment batches › Responses

List of person bulk enrichment batches

object[]

List of person bulk enrichment batches

Bulk enrichment status

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/{id}

Returns the status of a bulk enrichment (Tier 4)

Bulk enrichment status › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Bulk enrichment ID

Bulk enrichment status › Headers

x-api-key

string · required

API key for authentication

Bulk enrichment status › Responses

Bulk enrichment status

object[]

status

string · enum

Enum values:

ready

pending

purged

Fetch bulk enriched person

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/{id}/item/{itemId}

Returns a complete bulk enriched person (Tier 4)

Fetch bulk enriched person › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Bulk enrichment ID

itemId

string · required

Bulk enrichment item ID

Fetch bulk enriched person › Headers

x-api-key

string · required

API key for authentication

Fetch bulk enriched person › Responses

Bulk enrichment status

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

object

Get all person bulk enrichment items

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/enrich/bulk/{id}/items

Returns all enriched person items for a batch with cursor-based pagination (Tier 4)

Get all person bulk enrichment items › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Bulk enrichment batch ID

Get all person bulk enrichment items › query Parameters

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

limit

integer · int32

Maximum number of results to return (default: 20, max: 50)

Default: 20

Get all person bulk enrichment items › Headers

x-api-key

string · required

API key for authentication

Get all person bulk enrichment items › Responses

List of enriched person items with pagination

Response containing bulk enrichment items with pagination

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

object[]

List of enriched person data