apiDeterministic
Get gtm context
GET /api/v1/gtm-context
Read the workspace's full GTM context: personas, commercial offerings, campaign offers, canonical lead magnets, case studies, competitors, ICP criteria, company/service descriptions, and onboarding evidence keyed to the canonical saved asset IDs. Use this before generating messages, evaluating prospect fit, or recommending campaigns. Returns { configured: boolean, hint?: string } so you can detect incomplete setup and nudge the user to finish onboarding.
Parameters
workspaceId
string
Optional when using API key auth - inferred from the key.
Example
REST requestbash
curl -X GET "https://app.pipeline.help/api/v1/gtm-context" \-H "Authorization: Bearer $PIPELINE_API_KEY"
Response
Success response schemajson schema
{"type": "object","properties": {"workspaceId": {"type": "string"},"company": {"type": "object","properties": {"name": {"type": "string"},"description": {"type": "string"}}},"personas": {"type": "array","items": {"type": "object","properties": {"id": {"type": "string"},"workspaceId": {"type": "string"},"name": {"type": "string"},"slug": {"type": "string"},"title": {"type": "string"},"seniority": {"type": "string"},"department": {"type": "string"},"companySize": {"type": "string"},"industry": {"type": "string"},"painPoints": {"type": "array","items": {"type": "string"}},"goals": {"type": "array","items": {"type": "string"}},"buyingTriggers": {"type": "array","items": {"type": "string"}},"objections": {"type": "array","items": {"type": "string"}},"avoidTopics": {"type": "array","items": {"type": "string"}},"messagingAngle": {"type": "string"},"isActive": {"type": "boolean"},"createdAt": {"type": "string"},"updatedAt": {"type": "string"}},"required": ["id","workspaceId","name","slug","painPoints","goals","buyingTriggers","objections","avoidTopics","isActive","createdAt","updatedAt"]}},"offerings": {"type": "array","items": {"type": "object","properties": {"id": {"type": "string"},"workspaceId": {"type": "string"},"name": {"type": "string"},"slug": {"type": "string"},"type": {"type": "string","enum": ["product","service","hybrid"]},"description": {"type": "string"},"valueProposition": {"type": "string"},"keyFeatures": {"type": "array","items": {"type": "string"}},"idealFor": {"type": "string"},"pricingContext": {"type": "string"},"differentiators": {"type": "array","items": {"type": "string"}},"targetPersonaIds": {"type": "array","items": {"type": "string"}},"icpProfileId": {"type": "string"},"isActive": {"type": "boolean"},"createdAt": {"type": "string"},"updatedAt": {"type": "string"}},"required": ["id","workspaceId","name","slug","type","keyFeatures","differentiators","targetPersonaIds","isActive","createdAt","updatedAt"]}},"demandGenOffers": {"type": "array","items": {"type": "object","properties": {"id": {"type": "string"},"workspaceId": {"type": "string"},"name": {"type": "string"},"slug": {"type": "string"},"type": {"type": "string","enum": ["lead_magnet","trial","direct_offer","front_end_offer"]},"description": {"type": "string"},"cta": {"type": "string"},"deliveryMechanism": {"type": "string"},"offeringId": {"type": "string"},"icpProfileId": {"type": "string"},"version": {"type": "number"},"isActive": {"type": "boolean"},"createdAt": {"type": "string"},"updatedAt": {"type": "string"}},"required": ["id","workspaceId","name","slug","type","isActive","createdAt","updatedAt"]}},"leadMagnets": {"type": "array","items": {"type": "object","properties": {"id": {"type": "string"},"workspaceId": {"type": "string"},"name": {"type": "string"},"offeringId": {"type": "string"},"slug": {"type": "string"},"version": {"type": "number"},"description": {"type": "string"},"cta": {"type": "string"},"isActive": {"type": "boolean"},"createdAt": {"type": "string"},"updatedAt": {"type": "string"}},"required": ["id","workspaceId","name","slug","isActive","createdAt","updatedAt"]}},"caseStudies": {"type": "array","items": {"type": "object","properties": {"id": {"type": "string"},"workspaceId": {"type": "string"},"title": {"type": "string"},"customerName": {"type": "string"},"customerDomain": {"type": "string"},"industry": {"type": "string"},"summary": {"type": "string"},"metrics": {"type": "string"},"offeringId": {"type": "string"},"icpProfileId": {"type": "string"},"isActive": {"type": "boolean"},"createdAt": {"type": "string"},"updatedAt": {"type": "string"}},"required": ["id","workspaceId","title","customerName","summary","isActive","createdAt","updatedAt"]}},"competitors": {"type": "array","items": {"type": "object","properties": {"id": {"type": "string"},"workspaceId": {"type": "string"},"name": {"type": "string"},"domain": {"type": ["string","null"]},"website": {"type": ["string","null"]},"reason": {"type": "string"}},"required": ["id","workspaceId","name","domain","website","reason"]}},"icpCriteria": {"type": ["object","string"]},"icpSummary": {"type": "string"},"serviceDescription": {"type": "string"},"icp": {"type": "object"},"voiceConfig": {"type": "object"},"onboardingEvidence": {"type": "object","properties": {"company": {"type": "object","properties": {"origin": {"type": "string","enum": ["public_source","user_supplied"]},"sourceUrls": {"type": "array","items": {"type": "string","format": "uri"}}},"required": ["origin","sourceUrls"],"additionalProperties": false},"icp": {"type": "object","properties": {"origin": {"type": "string","enum": ["public_source","user_supplied"]},"sourceUrls": {"type": "array","items": {"type": "string","format": "uri"}}},"required": ["origin","sourceUrls"],"additionalProperties": false},"personasById": {"type": "object","additionalProperties": {"type": "object","properties": {"origin": {"type": "string","enum": ["public_source","user_supplied"]},"sourceUrls": {"type": "array","items": {"type": "string","format": "uri"}}},"required": ["origin","sourceUrls"],"additionalProperties": false}},"offeringsById": {"type": "object","additionalProperties": {"type": "object","properties": {"origin": {"type": "string","enum": ["public_source","user_supplied"]},"sourceUrls": {"type": "array","items": {"type": "string","format": "uri"}}},"required": ["origin","sourceUrls"],"additionalProperties": false}},"caseStudiesById": {"type": "object","additionalProperties": {"type": "object","properties": {"origin": {"type": "string","enum": ["public_source","user_supplied"]},"sourceUrls": {"type": "array","items": {"type": "string","format": "uri"}}},"required": ["origin","sourceUrls"],"additionalProperties": false}},"competitorsById": {"type": "object","additionalProperties": {"type": "object","properties": {"origin": {"type": "string","enum": ["public_source","user_supplied"]},"sourceUrls": {"type": "array","items": {"type": "string","format": "uri"}}},"required": ["origin","sourceUrls"],"additionalProperties": false}}},"required": ["company","icp","personasById","offeringsById","caseStudiesById","competitorsById"],"additionalProperties": false},"configured": {"type": "boolean"},"hint": {"type": "string"}},"required": ["workspaceId","personas","offerings","demandGenOffers","caseStudies","competitors","configured"]}
HTTP errors
- 401
- Missing or invalid API key.
- 403
- Authenticated but not permitted for the workspace or resource.
- 404
- The requested resource was not found.