Get all persons

//native

type Pipedrive = {

  apiToken: string;

};

/**

 * Get all persons

 * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.

 */

export async function main(

  auth: Pipedrive,

  filter_id: string | undefined,

  ids: string | undefined,

  owner_id: string | undefined,

  org_id: string | undefined,

  updated_since: string | undefined,

  updated_until: string | undefined,

  sort_by: "id" | "update_time" | "add_time" | undefined,

  sort_direction: "asc" | "desc" | undefined,

  include_fields:

    | "next_activity_id"

    | "last_activity_id"

    | "open_deals_count"

    | "related_open_deals_count"

    | "closed_deals_count"

    | "related_closed_deals_count"

    | "participant_open_deals_count"

    | "participant_closed_deals_count"

    | "email_messages_count"

    | "activities_count"

    | "done_activities_count"

    | "undone_activities_count"

    | "files_count"

    | "notes_count"

    | "followers_count"

    | "won_deals_count"

    | "related_won_deals_count"

    | "lost_deals_count"

    | "related_lost_deals_count"

    | "last_incoming_mail_time"

    | "last_outgoing_mail_time"

    | "marketing_status"

    | "doi_status"

    | undefined,

  custom_fields: string | undefined,

  limit: string | undefined,

  cursor: string | undefined,

) {

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

  for (const [k, v] of [

    ["filter_id", filter_id],

    ["ids", ids],

    ["owner_id", owner_id],

    ["org_id", org_id],

    ["updated_since", updated_since],

    ["updated_until", updated_until],

    ["sort_by", sort_by],

    ["sort_direction", sort_direction],

    ["include_fields", include_fields],

    ["custom_fields", custom_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();

}