POST/v1/contact-details/batch/poll

Poll batch contact details

Polls a batch contact details task. Returns partial results as they complete.

Fiber AI·Free

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "fiber",
  path: "/v1/contact-details/batch/poll",
  body: {
    "taskId": "example"
  }
});

console.log(output);

Body parameters

taskIdrequired

string

Task ID from the batch start endpoint.

cursor

string

Pagination cursor from previous poll response.

take

integer

Number of people to return per page. Defaults to 100.

Response

output.done

boolean

output.failed

boolean

output.nextCursor

null

output.pageResults.0.inputs.linkedinUrl.value

string

output.pageResults.0.outputs.phoneNumbers

array

output.overallStats.numFailed

number

output.overallStats.numRejected

number

output.overallStats.numCompleted

number

output.overallStats.numRemaining

number

output.overallStats.numDuplicates

number

output.overallStats.totalPeopleToFetch

number

chargeInfo.method

string

chargeInfo.message

string

chargeInfo.creditsCharged

number