logo Windmill Hub
Login
Back to HubSpot integration
0

List CRM Objects

by
Published today

List records of a CRM object type, one page at a time.

Script hubspot Verified
Use in Windmill

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 4 hours ago
All edits
Permalink
1 
//native
2
3 
export type DynSelect_object_type = string
4
5 
// Dropdown of the standard CRM object types plus the account's custom objects.
6 
export async function object_type(auth: RT.Hubspot) {
7 
  const standard = [
8 
    "contacts",
9 
    "companies",
10 
    "deals",
11 
    "tickets",
12 
    "line_items",
13 
    "products",
14 
    "quotes",
15 
    "leads",
16 
    "notes",
17 
    "tasks",
18 
    "meetings",
19 
    "calls",
20 
    "emails",
21 
    "communications",
22 
  ].map((o) => ({ value: o, label: o }))
23 
  const response = await fetch("https://api.hubapi.com/crm/v3/schemas", {
24 
    headers: {
25 
      Authorization: `Bearer ${auth.token}`,
26 
      Accept: "application/json",
27 
    },
28 
  })
29 
  // A token without crm.schemas.custom.read still gets the standard objects.
30 
  if (!response.ok) return standard
31 
  const { results } = (await response.json()) as {
32 
    results: { fullyQualifiedName: string; labels: { plural: string } }[]
33 
  }
34 
  return [
35 
    ...standard,
36 
    ...results.map((s) => ({
37 
      value: s.fullyQualifiedName,
38 
      label: `${s.labels.plural} (custom)`,
39 
    })),
40 
  ]
41 
}
42
43 
export type DynMultiselect_properties = string[]
44
45 
// Dependent checklist: the properties of the chosen object type.
46 
export async function properties(
47 
  auth: RT.Hubspot,
48 
  object_type: DynSelect_object_type
49 
) {
50 
  if (!object_type) return []
51 
  const response = await fetch(
52 
    `https://api.hubapi.com/crm/v3/properties/${object_type}`,
53 
    {
54 
      headers: {
55 
        Authorization: `Bearer ${auth.token}`,
56 
        Accept: "application/json",
57 
      },
58 
    }
59 
  )
60 
  if (!response.ok) {
61 
    throw new Error(`${response.status} ${await response.text()}`)
62 
  }
63 
  const { results } = (await response.json()) as {
64 
    results: { name: string; label: string }[]
65 
  }
66 
  return results.map((p) => ({
67 
    value: p.name,
68 
    label: `${p.label} (${p.name})`,
69 
  }))
70 
}
71
72 
/**
73 
 * List CRM Objects
74 
 * List records of a CRM object type, one page at a time. Paginate by passing `paging.next.after` as `after`. Use Search CRM Objects to filter. 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).
75 
 */
76 
export async function main(
77 
  auth: RT.Hubspot,
78 
  object_type: DynSelect_object_type,
79 
  properties: DynMultiselect_properties | undefined,
80 
  associations: string[] | undefined,
81 
  limit: number | undefined,
82 
  after: string | undefined,
83 
  archived: boolean | undefined
84 
) {
85 
  const url = new URL(`https://api.hubapi.com/crm/v3/objects/${object_type}`)
86 
  if (properties?.length)
87 
    url.searchParams.append("properties", properties.join(","))
88 
  if (associations?.length)
89 
    url.searchParams.append("associations", associations.join(","))
90 
  if (limit != null) url.searchParams.append("limit", String(limit))
91 
  if (after != null && after !== "") url.searchParams.append("after", after)
92 
  if (archived) url.searchParams.append("archived", String(archived))
93
94 
  const response = await fetch(url, {
95 
    headers: {
96 
      Authorization: `Bearer ${auth.token}`,
97 
      Accept: "application/json",
98 
    },
99 
  })
100
101 
  if (!response.ok) {
102 
    throw new Error(`${response.status} ${await response.text()}`)
103 
  }
104
105 
  return await response.json()
106 
}
107