Class ApolloPeopleClient

constructor

• new ApolloPeopleClient(
      apiKey: string,
      options?: ApolloPeopleClientOptions,
  ): ApolloPeopleClient

  Parameters

  • apiKey: string
  • Optionaloptions: ApolloPeopleClientOptions

  Returns ApolloPeopleClient

Static ReadonlyMaxBatchSize

BulkMatch

• BulkMatch(
      inputs: ApolloPersonMatchInput[],
      options?: ApolloBulkMatchOptions,
  ): Promise<ApolloBulkMatchResult>

  Parameters

  • inputs: ApolloPersonMatchInput[]
  • Optionaloptions: ApolloBulkMatchOptions

  Returns Promise<ApolloBulkMatchResult>

EnrichOrganization

• EnrichOrganization(domain: string): Promise<OrganizationEnrichmentOrganization>

  GET /organizations/enrich?domain= with header auth. Returns Apollo's organization record, or null when Apollo has nothing for the domain (a miss costs nothing).

  Parameters

  • domain: string

  Returns Promise<OrganizationEnrichmentOrganization>

StaticForCompany

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

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

  Parameters

  • companyID: string
  • contextUser: UserInfo
  • Optionaloptions: ApolloPeopleClientOptions

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