List Properties

//native

export type DynSelect_object_type = string

// Dropdown of the standard CRM object types plus the account's custom objects.

export async function object_type(auth: RT.Hubspot) {

  const standard = [

    "contacts",

    "companies",

    "deals",

    "tickets",

    "line_items",

    "products",

    "quotes",

    "leads",

    "notes",

    "tasks",

    "meetings",

    "calls",

    "emails",

    "communications",

  ].map((o) => ({ value: o, label: o }))

  const response = await fetch("https://api.hubapi.com/crm/v3/schemas", {

    headers: {

      Authorization: `Bearer ${auth.token}`,

      Accept: "application/json",

    },

  })

  // A token without crm.schemas.custom.read still gets the standard objects.

  if (!response.ok) return standard

  const { results } = (await response.json()) as {

    results: { fullyQualifiedName: string; labels: { plural: string } }[]

  }

  return [

    ...standard,

    ...results.map((s) => ({

      value: s.fullyQualifiedName,

      label: `${s.labels.plural} (custom)`,

    })),

  ]

}

/**

 * List Properties

 * List every property defined on a CRM object type, including custom objects, with its internal name, label, type and options. Object types other than contacts, companies and deals need their own scope on the connection (e.g. tickets, crm.objects.line_items.read, crm.objects.custom.read).

 */

export async function main(

  auth: RT.Hubspot,

  object_type: DynSelect_object_type,

  archived: boolean | undefined

) {

  const url = new URL(`https://api.hubapi.com/crm/v3/properties/${object_type}`)

  if (archived) url.searchParams.append("archived", String(archived))

  const response = await fetch(url, {

    headers: {

      Authorization: `Bearer ${auth.token}`,

      Accept: "application/json",

    },

  })

  if (!response.ok) {

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

  }

  return await response.json()

}