0

List Associations

by
Published today

List the IDs (and association types) of the records of one object type associated with a CRM record.

Script hubspot Verified

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 4 hours ago
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
/**
44
 * List Associations
45
 * List the IDs (and association types) of the records of one object type associated with a CRM record. Use Get Associated Objects to fetch the records themselves. 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).
46
 */
47
export async function main(
48
  auth: RT.Hubspot,
49
  object_type: DynSelect_object_type,
50
  object_id: string,
51
  to_object_type: DynSelect_object_type,
52
  limit: number | undefined,
53
  after: string | undefined
54
) {
55
  const url = new URL(
56
    `https://api.hubapi.com/crm/v4/objects/${object_type}/${object_id}/associations/${to_object_type}`
57
  )
58
  if (limit != null) url.searchParams.append("limit", String(limit))
59
  if (after != null && after !== "") url.searchParams.append("after", after)
60

61
  const response = await fetch(url, {
62
    headers: {
63
      Authorization: `Bearer ${auth.token}`,
64
      Accept: "application/json",
65
    },
66
  })
67

68
  if (!response.ok) {
69
    throw new Error(`${response.status} ${await response.text()}`)
70
  }
71

72
  return await response.json()
73
}
74