CRM

Manage contacts, companies, activities, and CRM data.

GET

Get one activity's description, writing app and JSON data payload

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/activities/{activityId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
activityIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { activities } = await gc.crm.listCrmActivities({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { activity } = await gc.crm.getCrmActivity({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  activityId: activities[0].id,22});23

GET

List the activity timeline for a whole CRM app, newest first, searchable

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/activities

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
contactId: query · string
companyId: query · string
writtenBy: query · string
createdAt: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { activities } = await gc.crm.listCrmActivities({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

POST

Log a past-tense sentence onto a contact or company timeline, append-only

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/activities

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

BodyRequired

data: object
companyId: string
contactId: string
writtenBy: string
descriptionRequired: string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const result = await gc.crm.logCrmActivity({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16  data: { type: "note", content: "Followed up with customer" },17});18

GET

List a company's activity timeline, newest first, whatever app logged it

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/companies/{companyId}/activities

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
writtenBy: query · string
contactId: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
companyIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { companies } = await gc.crm.listCrmCompanies({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { activities } = await gc.crm.listCrmCompanyActivities({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  companyId: companies[0].id,22});23

GET

List contacts linked to one company, paginated, alphabetical by last name

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/companies/{companyId}/contacts

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
status: query · string
source: query · string
title: query · string
department: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
companyIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { companies } = await gc.crm.listCrmCompanies({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { contacts } = await gc.crm.listCrmCompanyContacts({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  companyId: companies[0].id,22});23

GET

A company's timeline — its people's happenings, one stream

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/companies/{companyId}/edges

Parameters

page: query · number
pageSize: query · number
lite: query · string
limit: query · integer
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
companyIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { companies } = await gc.crm.listCrmCompanies({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { edges } = await gc.crm.listCrmCompanyEdges({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  companyId: companies[0].id,22});23

GET

Get one company with its profile fields and count of linked contacts

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/companies/{companyId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
companyIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { companies } = await gc.crm.listCrmCompanies({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { company } = await gc.crm.getCrmCompany({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  companyId: companies[0].id,22});23

GET

List companies in one CRM app, alphabetical by name, each with contact count

/organizations/{organizationId}/projects/{projectId}/apps/crm/{appId}/companies

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
name: query · string
industry: query · string
size: query · string
email: query · string
website: query · string
organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { companies } = await gc.crm.listCrmCompanies({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

BuiltAutonomously With AI

This content was built autonomously. Giant Context analyzed the site, determined what was missing, created and submitted an idea and draft, which Giant Context staff accepted and published.