People

The project's people — everyone a project knows, whether or not a CRM app is installed. A person's email is an identifier pointing at them, never a column; subscription lives on the address. The CRM app is a workspace over this surface.

POST

Approve the compiled segment for consumption

/organizations/{organizationId}/projects/{projectId}/segments/{segmentId}/approve

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
segmentIdRequired: 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 });7
8const result = await gc.people.approveSegment({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  segmentId: "segment-id",12});13

GET

Live membership preview — total, deliverable, sample

/organizations/{organizationId}/projects/{projectId}/segments/{segmentId}/preview

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
segmentIdRequired: 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 { segments } = await gc.people.listSegments({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const preview = await gc.people.getSegmentPreview({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  segmentId: segments[0].id,16});17

POST

Erase a person — sever, scrub, retain

/organizations/{organizationId}/projects/{projectId}/people/{personId}/erasures

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
personIdRequired: 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 });7
8const result = await gc.people.erasePerson({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  personId: "person-id",12});13

PUT

Set one custom field on a person, merging into properties

/organizations/{organizationId}/projects/{projectId}/people/{personId}/fields

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
personIdRequired: path · string

BodyRequired

keyRequired: string
valueRequired: any

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 });7
8const result = await gc.people.setPersonField({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  personId: "person-123",12  data: { customField: "value" }13});14

GET

A person's timeline of happenings, newest first

/organizations/{organizationId}/projects/{projectId}/people/{personId}/edges

Parameters

page: query · number
pageSize: query · number
lite: query · string
limit: query · integer
organizationIdRequired: path · string
projectIdRequired: path · string
personIdRequired: 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 });7
8const { edges } = await gc.people.listPersonEdges({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  personId: "person_123",12});13

POST

Tag one person with a single free-form string, idempotent, returns the person

/organizations/{organizationId}/projects/{projectId}/people/{personId}/tags

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
personIdRequired: path · string

BodyRequired

tagRequired: 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 });7
8const result = await gc.people.tagPerson({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  personId: "person_123",12  data: { tags: ["vip"] }13});14

DELETE

Remove one tag from a person, returns the person

/organizations/{organizationId}/projects/{projectId}/people/{personId}/tags

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
personIdRequired: path · string

BodyRequired

tagRequired: 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 });7
8const result = await gc.people.untagPerson({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  personId: "person-id",12  data: { tag: "example-tag" }13});14

GET

Every property key the project's people carry, with counts

/organizations/{organizationId}/projects/{projectId}/people/property-keys

Parameters

organizationIdRequired: path · string
projectIdRequired: 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 });7
8const { keys } = await gc.people.getPersonPropertyKeys({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11});12

POST

Merge a drifted property key into its canonical name

/organizations/{organizationId}/projects/{projectId}/people/property-keys

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string

BodyRequired

toKeyRequired: string
fromKeyRequired: 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 });7
8const result = await gc.people.mergePersonPropertyKeys({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  data: {}12});13

GET

One segment — description, compiled tree, gates

/organizations/{organizationId}/projects/{projectId}/segments/{segmentId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
segmentIdRequired: 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 });7
8const segment = await gc.people.getSegment({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  segmentId: "segment-id",12});13

PUT

Update a segment; a new description clears both gates

/organizations/{organizationId}/projects/{projectId}/segments/{segmentId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
segmentIdRequired: path · string

BodyRequired

name: string
description: 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 });7
8const result = await gc.people.updateSegment({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  segmentId: "segment-id",12  data: {},13});14

DELETE

Delete a segment definition

/organizations/{organizationId}/projects/{projectId}/segments/{segmentId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
segmentIdRequired: 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 });7
8const result = await gc.people.deleteSegment({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  segmentId: "segment-id",12});13

GET

Get one person with all fields, tags and the CRM company overlay

/organizations/{organizationId}/projects/{projectId}/people/{personId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
personIdRequired: 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 });7
8const person = await gc.people.getPerson({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  personId: "person-id",12});13

PATCH

Update person

/organizations/{organizationId}/projects/{projectId}/people/{personId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
personIdRequired: path · string

BodyRequired

tags: array
email: string
phone: string
title: string
locale: union
source: union
status: union
lastName: string
companyId: string
firstName: string
department: string
properties: object

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 });7
8const result = await gc.people.updatePerson({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  personId: "person-123",12  data: { name: "Jane Doe" }13});14

GET

Resolve a person by email address

/organizations/{organizationId}/projects/{projectId}/people/by-email

Parameters

emailRequired: query · string
organizationIdRequired: path · string
projectIdRequired: 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 });7
8const { person } = await gc.people.getPersonByEmail({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  email: "test@example.com",12});13

POST

Identify: name the person behind an email

/organizations/{organizationId}/projects/{projectId}/people/identify

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string

BodyRequired

emailRequired: string
traits: object
visitorId: 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 });7
8const result = await gc.people.identify({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  data: { email: "user@example.com", name: "Alice" }12});13

GET

The deletion ledger, newest first

/organizations/{organizationId}/projects/{projectId}/erasures

Parameters

page: query · number
pageSize: query · number
lite: query · string
organizationIdRequired: path · string
projectIdRequired: 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 });7
8const { erasures } = await gc.people.listErasures({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11});12

GET

The project's segments — saved, compiled views over people

/organizations/{organizationId}/projects/{projectId}/segments

Parameters

page: query · number
pageSize: query · number
lite: query · string
organizationIdRequired: path · string
projectIdRequired: 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 });7
8const { segments } = await gc.people.listSegments({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11});12

POST

Create a segment from a plain-language description

/organizations/{organizationId}/projects/{projectId}/segments

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string

BodyRequired

nameRequired: 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 });7
8const { segment } = await gc.people.createSegment({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  data: {12    name: "New Segment"13  }14});15

GET

List a project's people, alphabetical by last name, search supported

/organizations/{organizationId}/projects/{projectId}/people

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
locale: query · string
organizationIdRequired: path · string
projectIdRequired: 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 });7
8const { people } = await gc.people.listPeople({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11});12

POST

Create person

/organizations/{organizationId}/projects/{projectId}/people

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string

BodyRequired

tags: array
email: string
phone: string
title: string
locale: union
source: union
status: union
lastNameRequired: string
companyId: string
firstNameRequired: string
department: string
properties: object

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 });7
8const { person } = await gc.people.createPerson({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  data: {12    name: "John Doe",13    email: "john.doe@example.com"14  }15});16

POST

Track: record a happening as an edge

/organizations/{organizationId}/projects/{projectId}/edges

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string

BodyRequired

facts: object
object: object
statementRequired: string
visitorIdRequired: 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 });7
8const response = await gc.people.track({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  data: { event: "test_event" }12});13

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.