Class PDLPersonClient

constructor

• new PDLPersonClient(
      apiKey: string,
      options?: PDLPersonClientOptions,
  ): PDLPersonClient

  Parameters

  • apiKey: string
  • Optionaloptions: PDLPersonClientOptions

  Returns PDLPersonClient

Static ReadonlyMaxBatchSize

Static ReadonlyMaxSearchPageSize

BulkEnrich

• BulkEnrich(
      inputs: PDLPersonInput[],
      options?: PDLBulkOptions,
  ): Promise<PDLBulkResult>

  Parameters

  • inputs: PDLPersonInput[]
  • Optionaloptions: PDLBulkOptions

  Returns Promise<PDLBulkResult>

CleanSchool

• CleanSchool(name: string): Promise<PDLSchoolSuggestion>

  School Cleaner. Free of credits. Returns null when PDL can't resolve the name. Not trustworthy alone: confirm with SuggestSchools.

  Parameters

  • name: string

  Returns Promise<PDLSchoolSuggestion>

CountPeople

• CountPeople(
      query: PDLBoolQuery,
  ): Promise<{ CreditsConsumed: number; Total: number }>

  A size-1 search that returns only the total; the one record is discarded unmapped.

  Parameters

  • query: PDLBoolQuery

  Returns Promise<{ CreditsConsumed: number; Total: number }>

SearchPeople

• SearchPeople(request: PDLPersonSearchRequest): Promise<PDLPersonSearchPage>

  One page of Person Search. Billed per record returned. A no-records response is Total: 0, not an error.

  Parameters

  • request: PDLPersonSearchRequest

  Returns Promise<PDLPersonSearchPage>

SuggestSchools

• SuggestSchools(text: string, size?: number): Promise<PDLSchoolSuggestion[]>

  Autocomplete on field=school. Free of credits; rate-limited only.

  Parameters

  • text: string
  • size: number = 10

  Returns Promise<PDLSchoolSuggestion[]>

StaticForCompany

• ForCompany(
      companyID: string,
      contextUser: UserInfo,
      options?: PDLPersonClientOptions,
  ): Promise<
      { Client: PDLPersonClient; KeySource: "credential"
      | "environment" },
  >

  Resolve the key through the credentials path (company credential, then PDL_API_KEY), then construct a client.

  Parameters

  • companyID: string
  • contextUser: UserInfo
  • Optionaloptions: PDLPersonClientOptions

  Returns Promise<{ Client: PDLPersonClient; KeySource: "credential" | "environment" }>