Skip to main content

​
Growth API guide

This page documents Growth endpoints with usage guidance, parameter tables, and request/response examples.
For full contract detail and interactive testing, use the API Explorer in the sidebar.

​
Endpoint reference

​
GET /api/growth/opps

Use this endpoint to load opportunity cards for one snapshot date. Query parameters
NameTypeRequiredDescription
asOfDatestring (date)YesSnapshot date in YYYY-MM-DD format.
curl "<NSDK_API_BASE_URL>/api/growth/opps?asOfDate=2026-03-03" \
  -H "Authorization: Bearer <access-jwt>"
Common errors
  • 401: access token invalid or missing
  • 429: rate-limit protection

​
GET /api/growth/opp/detail

Use this endpoint when the user opens one opportunity detail. Query parameters
NameTypeRequiredDescription
insightIdstringYesOpportunity insight identifier.
curl "<NSDK_API_BASE_URL>/api/growth/opp/detail?insightId=12001" \
  -H "Authorization: Bearer <access-jwt>"
Common errors
  • 401: access token invalid or missing
  • 404: opportunity not found in user scope
  • 429: rate-limit protection

​
GET /api/growth/projects

Use this endpoint to list project execution state for the authenticated user. Query parameters
NameTypeRequiredDescription
None--No query parameters are required.
curl "<NSDK_API_BASE_URL>/api/growth/projects" \
  -H "Authorization: Bearer <access-jwt>"
Common errors
  • 401: access token invalid or missing
  • 429: rate-limit protection

​
POST /api/projects/from_opp

Use this endpoint to create a project from one selected opportunity. Request body
NameTypeRequiredDescription
insightIdstringYesSource opportunity insight identifier.
curl -X POST "<NSDK_API_BASE_URL>/api/projects/from_opp" \
  -H "Authorization: Bearer <access-jwt>" \
  -H "Content-Type: application/json" \
  -d '{
    "insightId": "12001"
  }'
Common errors
  • 400: invalid request payload
  • 401: access token invalid or missing
  • 429: rate-limit protection

​
POST /api/projects/active/set

Use this endpoint to activate or deactivate one project. Request body
NameTypeRequiredDescription
projectIdstringYesTarget project identifier.
isActivebooleanYesDesired active state.
curl -X POST "<NSDK_API_BASE_URL>/api/projects/active/set" \
  -H "Authorization: Bearer <access-jwt>" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "5501",
    "isActive": true
  }'
Common errors
  • 400: invalid request payload
  • 401: access token invalid or missing
  • 429: rate-limit protection