AggKnowledge API

Discover Basic

Endpointhttps://api.aggknowledgeai.com

V2 APIs for basic discover search

deprecated

Discover people

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people

Returns persons matching criteria (Tier 2)

Discover people › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Discover people › Headers

x-api-key

string · required

API key for authentication

Discover people › Request Body

Person discover request

aggkCompanyId

string[]

AggKnowledge Company IDs to restrict search to specific companies

aggkProductId

integer[]

AggKnowledge Product IDs

categoryId

integer[]

Category IDs

companyType

string[]

Company type

country

string

Company country

cursor

string

Pagination cursor from previous response for fetching next page of results

earliestCurrentStartDateAtCompany

string

Earliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestEndDate

string

Earliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestOriginalStartDateAtCompany

string

Earliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestStartDate

string

Earliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

employeeCountRange

string[]

Employee count ranges

object

Funding round count range

object

Total funding range

industry

string[]

Industry categories

jobTitle

string[]

Job titles

latestCurrentStartDateAtCompany

string

Latest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestEndDate

string

Latest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

object

Latest funding amount range

object

Latest funding date range

latestFundingStage

string[]

Latest funding stage

latestOriginalStartDateAtCompany

string

Latest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestStartDate

string

Latest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

limit

integer · int32

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

locality

string

Company locality

object

Caller-supplied metadata associated with the request

personCountry

string

Person country

personFilter

string · enum

Person employment filter

Enum values:

CURRENT

PAST_NOT_CURRENT

personLocality

string

Person locality (city)

personRegion

string

Person region (state)

primaryExchange

string[]

Primary exchanges

primaryTicker

string[]

Primary ticker symbols

region

string

Company region

revenueRangeInferred

string[]

Revenue range inferred

role

string[]

Roles

seniority

string[]

Seniority levels

subrole

string[]

Sub-roles

Discover people › Responses

Advanced person search results

object[]

List of persons matching the search criteria

hasProblems

boolean

Indicates if there are any problems with the request

isRetryable

boolean

Indicates if the request is retryable

isSuccess

boolean

Indicates if the request was successfully processed

object

Caller-supplied metadata associated with the request

nextCursor

string

Pagination cursor for fetching the next page of results

warnings

string[]

Non-fatal warnings about the search, such as filter degradation due to scale

POST/v2/{environment}/discover/people

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/discover/people \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "aggkCompanyId": [
    "string"
  ],
  "aggkProductId": [
    123456,
    789012
  ],
  "categoryId": [
    0
  ],
  "companyType": [
    "string"
  ],
  "country": "country",
  "cursor": "cursor",
  "earliestCurrentStartDateAtCompany": "earliestCurrentStartDateAtCompany",
  "earliestEndDate": "earliestEndDate",
  "earliestOriginalStartDateAtCompany": "earliestOriginalStartDateAtCompany",
  "earliestStartDate": "earliestStartDate",
  "employeeCountRange": [
    "string"
  ],
  "fundingRoundCount": {
    "key": 0
  },
  "fundingTotal": {
    "key": 0
  },
  "industry": [
    "string"
  ],
  "jobTitle": [
    "string"
  ],
  "latestCurrentStartDateAtCompany": "latestCurrentStartDateAtCompany",
  "latestEndDate": "latestEndDate",
  "latestFundingAmount": {
    "key": 0
  },
  "latestFundingDate": {
    "key": "2024-08-25"
  },
  "latestFundingStage": [
    "string"
  ],
  "latestOriginalStartDateAtCompany": "latestOriginalStartDateAtCompany",
  "latestStartDate": "latestStartDate",
  "limit": 100,
  "locality": "locality",
  "metadata": {
    "key": "string"
  },
  "personCountry": "personCountry",
  "personFilter": "CURRENT",
  "personLocality": "personLocality",
  "personRegion": "personRegion",
  "primaryExchange": [
    "string"
  ],
  "primaryTicker": [
    "string"
  ],
  "region": "region",
  "revenueRangeInferred": [
    "string"
  ],
  "role": [
    "string"
  ],
  "seniority": [
    "string"
  ],
  "subrole": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "aggkCompanyId": [
    "string"
  ],
  "aggkProductId": [
    123456,
    789012
  ],
  "categoryId": [
    0
  ],
  "companyType": [
    "string"
  ],
  "country": "country",
  "cursor": "cursor",
  "earliestCurrentStartDateAtCompany": "earliestCurrentStartDateAtCompany",
  "earliestEndDate": "earliestEndDate",
  "earliestOriginalStartDateAtCompany": "earliestOriginalStartDateAtCompany",
  "earliestStartDate": "earliestStartDate",
  "employeeCountRange": [
    "string"
  ],
  "fundingRoundCount": {
    "key": 0
  },
  "fundingTotal": {
    "key": 0
  },
  "industry": [
    "string"
  ],
  "jobTitle": [
    "string"
  ],
  "latestCurrentStartDateAtCompany": "latestCurrentStartDateAtCompany",
  "latestEndDate": "latestEndDate",
  "latestFundingAmount": {
    "key": 0
  },
  "latestFundingDate": {
    "key": "2024-08-25"
  },
  "latestFundingStage": [
    "string"
  ],
  "latestOriginalStartDateAtCompany": "latestOriginalStartDateAtCompany",
  "latestStartDate": "latestStartDate",
  "limit": 100,
  "locality": "locality",
  "metadata": {
    "key": "string"
  },
  "personCountry": "personCountry",
  "personFilter": "CURRENT",
  "personLocality": "personLocality",
  "personRegion": "personRegion",
  "primaryExchange": [
    "string"
  ],
  "primaryTicker": [
    "string"
  ],
  "region": "region",
  "revenueRangeInferred": [
    "string"
  ],
  "role": [
    "string"
  ],
  "seniority": [
    "string"
  ],
  "subrole": [
    "string"
  ]
}

json

Example Responses

{
  "data": [
    {
      "aggkCompanyId": 123456789,
      "aggkProductId": 987654321,
      "company": "AggKnowledge",
      "currentCompanies": [
        {
          "aggkCompanyId": 123456789,
          "companyType": "current",
          "currentStartDateAtCompany": "2022-01",
          "name": "AggKnowledge",
          "originalStartDateAtCompany": "2020-06",
          "totalStintsAtCompany": 2
        }
      ],
      "currentStartDateAtCompany": "2022-01",
      "endDate": "2023-11",
      "firstName": "daniel",
      "id": 590654273,
      "jobTitle": "Software Engineer",
      "lastName": "entrup",
      "linkedinUrl": "linkedin.com/in/danielentrup",
      "matchingCompany": {
        "aggkCompanyId": 47934076,
        "currentStartDateAtCompany": "2022-01",
        "endDate": "2023-11",
        "jobTitle": "business analyst & pmo - emea chief operations officer office",
        "name": "Salesforce",
        "originalStartDateAtCompany": "2020-06",
        "role": "analyst",
        "seniority": "cxo",
        "startDate": "2023-02",
        "subrole": "data_analyst",
        "totalStintsAtCompany": 2
      },
      "matchingProduct": {
        "aggkProductId": 987654321,
        "detectionFirstSeenAt": "2024-08-25",
        "detectionLastSeenAt": "2024-08-25",
        "productName": "Ordergroove"
      },
      "originalStartDateAtCompany": "2020-06",
      "personCountry": "United States",
      "personLocality": "San Francisco",
      "personRegion": "California",
      "productName": "Ordergroove",
      "role": "Engineering",
      "seniority": "Senior",
      "startDate": "2023-02",
      "subrole": "Backend",
      "totalStintsAtCompany": 2
    }
  ],
  "hasProblems": true,
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  },
  "nextCursor": "nextCursor",
  "warnings": [
    "string"
  ]
}

json

application/json

deprecated

Count discover people

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/count

Returns the count of persons matching criteria (Tier 2)

Count discover people › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Count discover people › Headers

x-api-key

string · required

API key for authentication

Count discover people › Request Body

Person discover request

aggkCompanyId

string[]

AggKnowledge Company IDs to restrict search to specific companies

aggkProductId

integer[]

AggKnowledge Product IDs

categoryId

integer[]

Category IDs

companyType

string[]

Company type

country

string

Company country

cursor

string

Pagination cursor from previous response for fetching next page of results

earliestCurrentStartDateAtCompany

string

Earliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestEndDate

string

Earliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestOriginalStartDateAtCompany

string

Earliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestStartDate

string

Earliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

employeeCountRange

string[]

Employee count ranges

object

Funding round count range

object

Total funding range

industry

string[]

Industry categories

jobTitle

string[]

Job titles

latestCurrentStartDateAtCompany

string

Latest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestEndDate

string

Latest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

object

Latest funding amount range

object

Latest funding date range

latestFundingStage

string[]

Latest funding stage

latestOriginalStartDateAtCompany

string

Latest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestStartDate

string

Latest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

limit

integer · int32

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

locality

string

Company locality

object

Caller-supplied metadata associated with the request

personCountry

string

Person country

personFilter

string · enum

Person employment filter

Enum values:

CURRENT

PAST_NOT_CURRENT

personLocality

string

Person locality (city)

personRegion

string

Person region (state)

primaryExchange

string[]

Primary exchanges

primaryTicker

string[]

Primary ticker symbols

region

string

Company region

revenueRangeInferred

string[]

Revenue range inferred

role

string[]

Roles

seniority

string[]

Seniority levels

subrole

string[]

Sub-roles

Count discover people › Responses

Count of matching persons

Response containing the count of matching results

count

integer · int64

Number of matching persons for the given search criteria

hasProblems

boolean

Whether the response contains any problems

isRetryable

boolean

Whether the operation is retryable in case of failure

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata echoed back from the request

POST/v2/{environment}/discover/people/count

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/discover/people/count \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "aggkCompanyId": [
    "string"
  ],
  "aggkProductId": [
    123456,
    789012
  ],
  "categoryId": [
    0
  ],
  "companyType": [
    "string"
  ],
  "country": "country",
  "cursor": "cursor",
  "earliestCurrentStartDateAtCompany": "earliestCurrentStartDateAtCompany",
  "earliestEndDate": "earliestEndDate",
  "earliestOriginalStartDateAtCompany": "earliestOriginalStartDateAtCompany",
  "earliestStartDate": "earliestStartDate",
  "employeeCountRange": [
    "string"
  ],
  "fundingRoundCount": {
    "key": 0
  },
  "fundingTotal": {
    "key": 0
  },
  "industry": [
    "string"
  ],
  "jobTitle": [
    "string"
  ],
  "latestCurrentStartDateAtCompany": "latestCurrentStartDateAtCompany",
  "latestEndDate": "latestEndDate",
  "latestFundingAmount": {
    "key": 0
  },
  "latestFundingDate": {
    "key": "2024-08-25"
  },
  "latestFundingStage": [
    "string"
  ],
  "latestOriginalStartDateAtCompany": "latestOriginalStartDateAtCompany",
  "latestStartDate": "latestStartDate",
  "limit": 100,
  "locality": "locality",
  "metadata": {
    "key": "string"
  },
  "personCountry": "personCountry",
  "personFilter": "CURRENT",
  "personLocality": "personLocality",
  "personRegion": "personRegion",
  "primaryExchange": [
    "string"
  ],
  "primaryTicker": [
    "string"
  ],
  "region": "region",
  "revenueRangeInferred": [
    "string"
  ],
  "role": [
    "string"
  ],
  "seniority": [
    "string"
  ],
  "subrole": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "aggkCompanyId": [
    "string"
  ],
  "aggkProductId": [
    123456,
    789012
  ],
  "categoryId": [
    0
  ],
  "companyType": [
    "string"
  ],
  "country": "country",
  "cursor": "cursor",
  "earliestCurrentStartDateAtCompany": "earliestCurrentStartDateAtCompany",
  "earliestEndDate": "earliestEndDate",
  "earliestOriginalStartDateAtCompany": "earliestOriginalStartDateAtCompany",
  "earliestStartDate": "earliestStartDate",
  "employeeCountRange": [
    "string"
  ],
  "fundingRoundCount": {
    "key": 0
  },
  "fundingTotal": {
    "key": 0
  },
  "industry": [
    "string"
  ],
  "jobTitle": [
    "string"
  ],
  "latestCurrentStartDateAtCompany": "latestCurrentStartDateAtCompany",
  "latestEndDate": "latestEndDate",
  "latestFundingAmount": {
    "key": 0
  },
  "latestFundingDate": {
    "key": "2024-08-25"
  },
  "latestFundingStage": [
    "string"
  ],
  "latestOriginalStartDateAtCompany": "latestOriginalStartDateAtCompany",
  "latestStartDate": "latestStartDate",
  "limit": 100,
  "locality": "locality",
  "metadata": {
    "key": "string"
  },
  "personCountry": "personCountry",
  "personFilter": "CURRENT",
  "personLocality": "personLocality",
  "personRegion": "personRegion",
  "primaryExchange": [
    "string"
  ],
  "primaryTicker": [
    "string"
  ],
  "region": "region",
  "revenueRangeInferred": [
    "string"
  ],
  "role": [
    "string"
  ],
  "seniority": [
    "string"
  ],
  "subrole": [
    "string"
  ]
}

json

Example Responses

{
  "count": 0,
  "hasProblems": true,
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  }
}

json

application/json

deprecated

Validate a discover people request

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/validate

Validates all field values in a discover people request and returns detailed warnings for any invalid values (especially enums such as role, industry, seniority). Does not perform a search or consume credits. (Tier 2)

Validate a discover people request › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Validate a discover people request › Headers

x-api-key

string · required

API key for authentication

Validate a discover people request › Request Body

Person discover request

aggkCompanyId

string[]

AggKnowledge Company IDs to restrict search to specific companies

aggkProductId

integer[]

AggKnowledge Product IDs

categoryId

integer[]

Category IDs

companyType

string[]

Company type

country

string

Company country

cursor

string

Pagination cursor from previous response for fetching next page of results

earliestCurrentStartDateAtCompany

string

Earliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestEndDate

string

Earliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestOriginalStartDateAtCompany

string

Earliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestStartDate

string

Earliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

employeeCountRange

string[]

Employee count ranges

object

Funding round count range

object

Total funding range

industry

string[]

Industry categories

jobTitle

string[]

Job titles

latestCurrentStartDateAtCompany

string

Latest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestEndDate

string

Latest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

object

Latest funding amount range

object

Latest funding date range

latestFundingStage

string[]

Latest funding stage

latestOriginalStartDateAtCompany

string

Latest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestStartDate

string

Latest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

limit

integer · int32

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

locality

string

Company locality

object

Caller-supplied metadata associated with the request

personCountry

string

Person country

personFilter

string · enum

Person employment filter

Enum values:

CURRENT

PAST_NOT_CURRENT

personLocality

string

Person locality (city)

personRegion

string

Person region (state)

primaryExchange

string[]

Primary exchanges

primaryTicker

string[]

Primary ticker symbols

region

string

Company region

revenueRangeInferred

string[]

Revenue range inferred

role

string[]

Roles

seniority

string[]

Seniority levels

subrole

string[]

Sub-roles

Validate a discover people request › Responses

Validation result with warnings for any invalid values

Response containing the results of request validation

isValid

boolean

Whether all provided values are valid (true when warnings is empty)

object

Caller-supplied metadata echoed back from the request

object[]

List of validation warnings, one per invalid field value

POST/v2/{environment}/discover/people/validate

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/discover/people/validate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "aggkCompanyId": [
    "string"
  ],
  "aggkProductId": [
    123456,
    789012
  ],
  "categoryId": [
    0
  ],
  "companyType": [
    "string"
  ],
  "country": "country",
  "cursor": "cursor",
  "earliestCurrentStartDateAtCompany": "earliestCurrentStartDateAtCompany",
  "earliestEndDate": "earliestEndDate",
  "earliestOriginalStartDateAtCompany": "earliestOriginalStartDateAtCompany",
  "earliestStartDate": "earliestStartDate",
  "employeeCountRange": [
    "string"
  ],
  "fundingRoundCount": {
    "key": 0
  },
  "fundingTotal": {
    "key": 0
  },
  "industry": [
    "string"
  ],
  "jobTitle": [
    "string"
  ],
  "latestCurrentStartDateAtCompany": "latestCurrentStartDateAtCompany",
  "latestEndDate": "latestEndDate",
  "latestFundingAmount": {
    "key": 0
  },
  "latestFundingDate": {
    "key": "2024-08-25"
  },
  "latestFundingStage": [
    "string"
  ],
  "latestOriginalStartDateAtCompany": "latestOriginalStartDateAtCompany",
  "latestStartDate": "latestStartDate",
  "limit": 100,
  "locality": "locality",
  "metadata": {
    "key": "string"
  },
  "personCountry": "personCountry",
  "personFilter": "CURRENT",
  "personLocality": "personLocality",
  "personRegion": "personRegion",
  "primaryExchange": [
    "string"
  ],
  "primaryTicker": [
    "string"
  ],
  "region": "region",
  "revenueRangeInferred": [
    "string"
  ],
  "role": [
    "string"
  ],
  "seniority": [
    "string"
  ],
  "subrole": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "aggkCompanyId": [
    "string"
  ],
  "aggkProductId": [
    123456,
    789012
  ],
  "categoryId": [
    0
  ],
  "companyType": [
    "string"
  ],
  "country": "country",
  "cursor": "cursor",
  "earliestCurrentStartDateAtCompany": "earliestCurrentStartDateAtCompany",
  "earliestEndDate": "earliestEndDate",
  "earliestOriginalStartDateAtCompany": "earliestOriginalStartDateAtCompany",
  "earliestStartDate": "earliestStartDate",
  "employeeCountRange": [
    "string"
  ],
  "fundingRoundCount": {
    "key": 0
  },
  "fundingTotal": {
    "key": 0
  },
  "industry": [
    "string"
  ],
  "jobTitle": [
    "string"
  ],
  "latestCurrentStartDateAtCompany": "latestCurrentStartDateAtCompany",
  "latestEndDate": "latestEndDate",
  "latestFundingAmount": {
    "key": 0
  },
  "latestFundingDate": {
    "key": "2024-08-25"
  },
  "latestFundingStage": [
    "string"
  ],
  "latestOriginalStartDateAtCompany": "latestOriginalStartDateAtCompany",
  "latestStartDate": "latestStartDate",
  "limit": 100,
  "locality": "locality",
  "metadata": {
    "key": "string"
  },
  "personCountry": "personCountry",
  "personFilter": "CURRENT",
  "personLocality": "personLocality",
  "personRegion": "personRegion",
  "primaryExchange": [
    "string"
  ],
  "primaryTicker": [
    "string"
  ],
  "region": "region",
  "revenueRangeInferred": [
    "string"
  ],
  "role": [
    "string"
  ],
  "seniority": [
    "string"
  ],
  "subrole": [
    "string"
  ]
}

json

Example Responses

{
  "isValid": true,
  "metadata": {
    "key": "string"
  },
  "warnings": [
    {
      "code": "code",
      "field": "field",
      "message": "message",
      "validValues": [
        "string"
      ],
      "value": "value"
    }
  ]
}

json

application/json

Contact Info Discover Advanced

Discover people

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people

Returns persons matching criteria (Tier 2)

Discover people › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Discover people › Headers

x-api-key

string · required

API key for authentication

Discover people › Request Body

Person discover request

aggkCompanyId

string[]

AggKnowledge Company IDs to restrict search to specific companies

aggkProductId

integer[]

AggKnowledge Product IDs

categoryId

integer[]

Category IDs

companyType

string[]

Company type

country

string

Company country

cursor

string

Pagination cursor from previous response for fetching next page of results

earliestCurrentStartDateAtCompany

string

Earliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestEndDate

string

Earliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestOriginalStartDateAtCompany

string

Earliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestStartDate

string

Earliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

employeeCountRange

string[]

Employee count ranges

object

Funding round count range

object

Total funding range

industry

string[]

Industry categories

jobTitle

string[]

Job titles

latestCurrentStartDateAtCompany

string

Latest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestEndDate

string

Latest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

object

Latest funding amount range

object

Latest funding date range

latestFundingStage

string[]

Latest funding stage

latestOriginalStartDateAtCompany

string

Latest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestStartDate

string

Latest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

limit

integer · int32

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

locality

string

Company locality

object

Caller-supplied metadata associated with the request

personCountry

string

Person country

personFilter

string · enum

Person employment filter

Enum values:

CURRENT

PAST_NOT_CURRENT

personLocality

string

Person locality (city)

personRegion

string

Person region (state)

primaryExchange

string[]

Primary exchanges

primaryTicker

string[]

Primary ticker symbols

region

string

Company region

revenueRangeInferred

string[]

Revenue range inferred

role

string[]

Roles

seniority

string[]

Seniority levels

subrole

string[]

Sub-roles

Discover people › Responses

Advanced person search results

object[]

List of persons matching the search criteria

hasProblems

boolean

Indicates if there are any problems with the request

isRetryable

boolean

Indicates if the request is retryable

isSuccess

boolean

Indicates if the request was successfully processed

object

Caller-supplied metadata associated with the request

nextCursor

string

Pagination cursor for fetching the next page of results

warnings

string[]

Non-fatal warnings about the search, such as filter degradation due to scale

Count discover people

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/count

Returns the count of persons matching criteria (Tier 2)

Count discover people › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Count discover people › Headers

x-api-key

string · required

API key for authentication

Count discover people › Request Body

Person discover request

aggkCompanyId

string[]

AggKnowledge Company IDs to restrict search to specific companies

aggkProductId

integer[]

AggKnowledge Product IDs

categoryId

integer[]

Category IDs

companyType

string[]

Company type

country

string

Company country

cursor

string

Pagination cursor from previous response for fetching next page of results

earliestCurrentStartDateAtCompany

string

Earliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestEndDate

string

Earliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestOriginalStartDateAtCompany

string

Earliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestStartDate

string

Earliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

employeeCountRange

string[]

Employee count ranges

object

Funding round count range

object

Total funding range

industry

string[]

Industry categories

jobTitle

string[]

Job titles

latestCurrentStartDateAtCompany

string

Latest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestEndDate

string

Latest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

object

Latest funding amount range

object

Latest funding date range

latestFundingStage

string[]

Latest funding stage

latestOriginalStartDateAtCompany

string

Latest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestStartDate

string

Latest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

limit

integer · int32

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

locality

string

Company locality

object

Caller-supplied metadata associated with the request

personCountry

string

Person country

personFilter

string · enum

Person employment filter

Enum values:

CURRENT

PAST_NOT_CURRENT

personLocality

string

Person locality (city)

personRegion

string

Person region (state)

primaryExchange

string[]

Primary exchanges

primaryTicker

string[]

Primary ticker symbols

region

string

Company region

revenueRangeInferred

string[]

Revenue range inferred

role

string[]

Roles

seniority

string[]

Seniority levels

subrole

string[]

Sub-roles

Count discover people › Responses

Count of matching persons

Response containing the count of matching results

count

integer · int64

Number of matching persons for the given search criteria

hasProblems

boolean

Whether the response contains any problems

isRetryable

boolean

Whether the operation is retryable in case of failure

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata echoed back from the request

Validate a discover people request

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/validate

Validate a discover people request › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Validate a discover people request › Headers

x-api-key

string · required

API key for authentication

Validate a discover people request › Request Body

Person discover request

aggkCompanyId

string[]

AggKnowledge Company IDs to restrict search to specific companies

aggkProductId

integer[]

AggKnowledge Product IDs

categoryId

integer[]

Category IDs

companyType

string[]

Company type

country

string

Company country

cursor

string

Pagination cursor from previous response for fetching next page of results

earliestCurrentStartDateAtCompany

string

Earliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestEndDate

string

Earliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestOriginalStartDateAtCompany

string

Earliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

earliestStartDate

string

Earliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

employeeCountRange

string[]

Employee count ranges

object

Funding round count range

object

Total funding range

industry

string[]

Industry categories

jobTitle

string[]

Job titles

latestCurrentStartDateAtCompany

string

Latest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestEndDate

string

Latest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

object

Latest funding amount range

object

Latest funding date range

latestFundingStage

string[]

Latest funding stage

latestOriginalStartDateAtCompany

string

Latest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)

latestStartDate

string

Latest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)

limit

integer · int32

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

locality

string

Company locality

object

Caller-supplied metadata associated with the request

personCountry

string

Person country

personFilter

string · enum

Person employment filter

Enum values:

CURRENT

PAST_NOT_CURRENT

personLocality

string

Person locality (city)

personRegion

string

Person region (state)

primaryExchange

string[]

Primary exchanges

primaryTicker

string[]

Primary ticker symbols

region

string

Company region

revenueRangeInferred

string[]

Revenue range inferred

role

string[]

Roles

seniority

string[]

Seniority levels

subrole

string[]

Sub-roles

Validate a discover people request › Responses

Validation result with warnings for any invalid values

Response containing the results of request validation

isValid

boolean

Whether all provided values are valid (true when warnings is empty)

object

Caller-supplied metadata echoed back from the request

object[]

List of validation warnings, one per invalid field value