Search persons

//native

type Pipedrive = {

  apiToken: string;

};

/**

 * Search persons

 * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID.

 */

export async function main(

  auth: Pipedrive,

  term: string | undefined,

  fields: "custom_fields" | "email" | "notes" | "phone" | "name" | undefined,

  exact_match: string | undefined,

  organization_id: string | undefined,

  include_fields: "person.picture" | undefined,

  limit: string | undefined,

  cursor: string | undefined,

) {

  const url = new URL(`https://api.pipedrive.com/api/v2/persons/search`);

  for (const [k, v] of [

    ["term", term],

    ["fields", fields],

    ["exact_match", exact_match],

    ["organization_id", organization_id],

    ["include_fields", include_fields],

    ["limit", limit],

    ["cursor", cursor],

  ]) {

    if (v !== undefined && v !== "" && k !== undefined) {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      "x-api-token": auth.apiToken,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}