Objectuve

Objectuve API Reference

Internal API documentation — access restricted

ObjectuveAPI

Objectuve API Reference

Objectuve API

The Objectuve API is a single GraphQL endpoint with real-time WebSocket subscriptions.

GraphQL endpoint
POST/graphql
WebSocket
WS/cable

Authentication

Objectuve uses Clerk for authentication. Clerk issues RS256 JWTs verified via JWKS on the backend.

Include the Clerk session token in every authenticated request using the SessionToken header:

SessionToken: <clerk-jwt-token>

Obtain a token via Clerk.session.getToken() on the client.

Important: The header name is SessionToken (PascalCase). It is not Authorization or Bearer.

On first sign-in, call the syncUser mutation to create or sync the local user record. This returns firstSignIn: true for new users who need onboarding.

Key Features

  • User ManagementSync Clerk profiles, manage usernames, photos, and showcased achievements
  • Goal TrackingCreate goals with milestones, log progress events, track streaks and XP
  • Habit Check-insOne-tap daily check-ins with streak tracking and freeze tokens
  • CommunitiesCreate and join interest groups, share goals, post updates, view feeds
  • Mood LoggingDaily check-ins (amazing / happy / calm / meh / tired / low) with optional goal linkage
  • Coach FeaturesGenerate milestones, refine descriptions, request advice, and receive personalized insights
  • GamificationXP, levels, ranks (Open Road → Horizon), badges (Common / Rare / Epic / Legendary)
  • Real-timeSubscribe to live notification and action updates via WebSocket (ActionCable)

ID Convention

All record IDs exposed by this API are public_id values — URL-safe base64 tokens. Internal integer IDs are never returned. Use public_id values for all lookups and references.

API Endpoints
# Production:
https://api.objectuve.com/graphql
# Staging:
https://staging.api.objectuve.com/graphql
# Local Development:
http://localhost:3000/graphql
Version

1.0.0

Queries

accountabilityPartner

Description

Returns the active accountability partner for a user, or null if none.

Response

Returns an AccountabilityPartner

Arguments
Name Description
userId - ID public_id of the user whose accountability partner to retrieve. Defaults to the current user.

Example

Query
query accountabilityPartner($userId: ID) {
  accountabilityPartner(userId: $userId) {
    accountabilityPartnerSince
    cheerSentToday
    firstName
    lastName
    longestMutualStreak
    mutualStreakCount
    mutualStreakLastDate
    nudgeSentToday
    partnerCheckedInToday
    photo {
      ...UserPhotoFragment
    }
    publicId
    recentActivity {
      ...PartnerActivityItemFragment
    }
    userCheckedInToday
    username
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "accountabilityPartner": {
      "accountabilityPartnerSince": ISO8601DateTime,
      "cheerSentToday": false,
      "firstName": "abc123",
      "lastName": "abc123",
      "longestMutualStreak": 987,
      "mutualStreakCount": 987,
      "mutualStreakLastDate": ISO8601Date,
      "nudgeSentToday": false,
      "partnerCheckedInToday": true,
      "photo": UserPhoto,
      "publicId": "4",
      "recentActivity": [PartnerActivityItem],
      "userCheckedInToday": false,
      "username": "xyz789"
    }
  }
}

activeSeasonalEvent

Description

The current active seasonal event, if any.

Response

Returns a SeasonalEvent

Example

Query
query activeSeasonalEvent {
  activeSeasonalEvent {
    badgeIcon
    badgeName
    createdAtTime
    currentUserParticipant {
      ...SeasonalEventParticipantFragment
    }
    description
    endDate
    isActive
    isParticipating
    name
    participantCount
    publicId
    slug
    startDate
    status
    targetGoalCount
    updatedAtTime
  }
}
Response
{
  "data": {
    "activeSeasonalEvent": {
      "badgeIcon": "abc123",
      "badgeName": "xyz789",
      "createdAtTime": "xyz789",
      "currentUserParticipant": SeasonalEventParticipant,
      "description": "abc123",
      "endDate": ISO8601Date,
      "isActive": false,
      "isParticipating": true,
      "name": "xyz789",
      "participantCount": 123,
      "publicId": 4,
      "slug": "xyz789",
      "startDate": ISO8601Date,
      "status": "xyz789",
      "targetGoalCount": 987,
      "updatedAtTime": "abc123"
    }
  }
}

activeSeasonalEvents

Description

Lists currently active seasonal events.

Response

Returns [SeasonalEvent!]

Example

Query
query activeSeasonalEvents {
  activeSeasonalEvents {
    badgeIcon
    badgeName
    createdAtTime
    currentUserParticipant {
      ...SeasonalEventParticipantFragment
    }
    description
    endDate
    isActive
    isParticipating
    name
    participantCount
    publicId
    slug
    startDate
    status
    targetGoalCount
    updatedAtTime
  }
}
Response
{
  "data": {
    "activeSeasonalEvents": [
      {
        "badgeIcon": "xyz789",
        "badgeName": "xyz789",
        "createdAtTime": "abc123",
        "currentUserParticipant": SeasonalEventParticipant,
        "description": "abc123",
        "endDate": ISO8601Date,
        "isActive": true,
        "isParticipating": true,
        "name": "abc123",
        "participantCount": 123,
        "publicId": "4",
        "slug": "xyz789",
        "startDate": ISO8601Date,
        "status": "xyz789",
        "targetGoalCount": 123,
        "updatedAtTime": "abc123"
      }
    ]
  }
}

adminActions

Description

Admin only. Audit log, newest first, cursor-paginated.

Response

Returns an AdminActionConnection!

Arguments
Name Description
actionType - String
actorId - ID
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
scopedTo - String Bucket filter — e.g. 'demo_data' narrows to Phase 30 demo-data actions.
targetType - String

Example

Query
query adminActions(
  $actionType: String,
  $actorId: ID,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $scopedTo: String,
  $targetType: String
) {
  adminActions(
    actionType: $actionType,
    actorId: $actorId,
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    scopedTo: $scopedTo,
    targetType: $targetType
  ) {
    edges {
      ...AdminActionEdgeFragment
    }
    nodes {
      ...AdminActionFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "actionType": "abc123",
  "actorId": 4,
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 123,
  "scopedTo": "xyz789",
  "targetType": "abc123"
}
Response
{
  "data": {
    "adminActions": {
      "edges": [AdminActionEdge],
      "nodes": [AdminAction],
      "pageInfo": PageInfo
    }
  }
}

adminAiUsage

Description

Returns aggregated AI spend and usage for the admin dashboard. Admin only.

Response

Returns an AdminAiUsage

Arguments
Name Description
daysBack - Int Number of days to look back for AI spend aggregation. Defaults to 30. Default = 30

Example

Query
query adminAiUsage($daysBack: Int) {
  adminAiUsage(daysBack: $daysBack) {
    budgetCents
    budgetUtilizationPercent
    dailySeries {
      ...DailyUsagePointFragment
    }
    perFeature {
      ...FeatureUsagePointFragment
    }
    perModel {
      ...ModelUsagePointFragment
    }
    perResolvedModel {
      ...ResolvedModelUsagePointFragment
    }
    totalCalls
    totalSpendCents
    totalTokens
  }
}
Variables
{"daysBack": 30}
Response
{
  "data": {
    "adminAiUsage": {
      "budgetCents": 123,
      "budgetUtilizationPercent": 123.45,
      "dailySeries": [DailyUsagePoint],
      "perFeature": [FeatureUsagePoint],
      "perModel": [ModelUsagePoint],
      "perResolvedModel": [ResolvedModelUsagePoint],
      "totalCalls": 987,
      "totalSpendCents": 123,
      "totalTokens": 987
    }
  }
}

adminCommunities

Description

Admin only (view_communities). Every non-deleted community, newest first, with no discovery-threshold filter.

Response

Returns an AdminCommunityConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
includeDemo - Boolean Include demo-tagged communities (excluded by default). Default = false
last - Int Returns the last n elements from the list.
query - String Case-insensitive match on name.

Example

Query
query adminCommunities(
  $after: String,
  $before: String,
  $first: Int,
  $includeDemo: Boolean,
  $last: Int,
  $query: String
) {
  adminCommunities(
    after: $after,
    before: $before,
    first: $first,
    includeDemo: $includeDemo,
    last: $last,
    query: $query
  ) {
    edges {
      ...AdminCommunityEdgeFragment
    }
    nodes {
      ...AdminCommunityFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "includeDemo": false,
  "last": 123,
  "query": "xyz789"
}
Response
{
  "data": {
    "adminCommunities": {
      "edges": [AdminCommunityEdge],
      "nodes": [AdminCommunity],
      "pageInfo": PageInfo,
      "totalCount": 987
    }
  }
}

adminDashboardPins

Description

Any admin role. The caller's own pinned Dashboard cards, in pin order.

Response

Returns [AdminDashboardPin!]!

Example

Query
query adminDashboardPins {
  adminDashboardPins {
    cardKey
    createdAt
    id
    pinnedVia
  }
}
Response
{
  "data": {
    "adminDashboardPins": [
      {
        "cardKey": "xyz789",
        "createdAt": ISO8601DateTime,
        "id": "4",
        "pinnedVia": "xyz789"
      }
    ]
  }
}

adminSearchUsers

Description

Admin only. pg_trgm-backed user search; sub-200ms on 100K users.

Response

Returns an AdminUserConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
demo - Boolean Omitted returns everyone; true returns only demo users; false returns only non-demo (real) users. ANDs with query and filter.
filter - AdminUserFilter Structured filter; ANDs with query.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
query - String Trigram search string (4+ chars recommended); optional with a filter.

Example

Query
query adminSearchUsers(
  $after: String,
  $before: String,
  $demo: Boolean,
  $filter: AdminUserFilter,
  $first: Int,
  $last: Int,
  $query: String
) {
  adminSearchUsers(
    after: $after,
    before: $before,
    demo: $demo,
    filter: $filter,
    first: $first,
    last: $last,
    query: $query
  ) {
    edges {
      ...UserEdgeFragment
    }
    nodes {
      ...UserFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "demo": true,
  "filter": AdminUserFilter,
  "first": 123,
  "last": 987,
  "query": "abc123"
}
Response
{
  "data": {
    "adminSearchUsers": {
      "edges": [UserEdge],
      "nodes": [User],
      "pageInfo": PageInfo,
      "totalCount": 123
    }
  }
}

adminStats

Description

Returns platform-wide statistics for the admin dashboard. Admin or marketing role; recentActivity is empty for marketing.

Response

Returns an AdminStats

Arguments
Name Description
daysBack - Int Number of days to look back for time-series metrics. Defaults to 90. Default = 90

Example

Query
query adminStats($daysBack: Int) {
  adminStats(daysBack: $daysBack) {
    completedGoals
    criticalFlags
    goalCategories {
      ...CategoryStatsFragment
    }
    goalsLast7Days
    growthData {
      ...GrowthDataPointFragment
    }
    monthlyActiveUsers
    pendingFlags
    pendingReports
    publicGoals
    recentActivity {
      ...ActivityItemFragment
    }
    supporterStats {
      ...SupporterStatsFragment
    }
    totalEncouragements
    totalEvents
    totalGoals
    totalMilestones
    totalUpdates
    totalUsers
    usersLast30Days
    usersLast7Days
  }
}
Variables
{"daysBack": 90}
Response
{
  "data": {
    "adminStats": {
      "completedGoals": 123,
      "criticalFlags": 987,
      "goalCategories": [CategoryStats],
      "goalsLast7Days": 123,
      "growthData": [GrowthDataPoint],
      "monthlyActiveUsers": 123,
      "pendingFlags": 123,
      "pendingReports": 987,
      "publicGoals": 987,
      "recentActivity": [ActivityItem],
      "supporterStats": SupporterStats,
      "totalEncouragements": 123,
      "totalEvents": 123,
      "totalGoals": 987,
      "totalMilestones": 987,
      "totalUpdates": 987,
      "totalUsers": 123,
      "usersLast30Days": 987,
      "usersLast7Days": 987
    }
  }
}

adminTeamsMonitoring

Description

Admin-only. Read-only Teams monitoring list (M11, PRIVACY-3): seat count, subscription status, and last-active per team.

Response

Returns [AdminTeamMonitoring!]

Example

Query
query adminTeamsMonitoring {
  adminTeamsMonitoring {
    lastActiveAt
    seatCountUsed
    seatLimit
    subscriptionStatus
    teamName
    teamPublicId
  }
}
Response
{
  "data": {
    "adminTeamsMonitoring": [
      {
        "lastActiveAt": ISO8601DateTime,
        "seatCountUsed": 123,
        "seatLimit": 987,
        "subscriptionStatus": "abc123",
        "teamName": "abc123",
        "teamPublicId": "xyz789"
      }
    ]
  }
}

adminUserSegments

Description

Any admin role. The caller's own saved user segments, oldest first.

Response

Returns [AdminUserSegment!]!

Example

Query
query adminUserSegments {
  adminUserSegments {
    createdAt
    filter {
      ...AdminUserSegmentFilterFragment
    }
    id
    name
  }
}
Response
{
  "data": {
    "adminUserSegments": [
      {
        "createdAt": ISO8601DateTime,
        "filter": AdminUserSegmentFilter,
        "id": "4",
        "name": "xyz789"
      }
    ]
  }
}

aiAssets

Description

Brand images rendered by agents (render_brand_asset), newest first, capped at 200. Marketing callers see marketing-crew assets only.

Response

Returns [AiAsset!]!

Arguments
Name Description
agentId - ID public_id of the AI employee that rendered the asset.
since - ISO8601DateTime
size - String One of square, portrait, landscape, og.

Example

Query
query aiAssets(
  $agentId: ID,
  $since: ISO8601DateTime,
  $size: String
) {
  aiAssets(
    agentId: $agentId,
    since: $since,
    size: $size
  ) {
    aiArtifact {
      ...AiArtifactFragment
    }
    aiEmployee {
      ...AiEmployeeFragment
    }
    createdAt
    height
    id
    layout
    url
    width
  }
}
Variables
{
  "agentId": "4",
  "since": ISO8601DateTime,
  "size": "abc123"
}
Response
{
  "data": {
    "aiAssets": [
      {
        "aiArtifact": AiArtifact,
        "aiEmployee": AiEmployee,
        "createdAt": ISO8601DateTime,
        "height": 987,
        "id": "abc123",
        "layout": "xyz789",
        "url": "abc123",
        "width": 987
      }
    ]
  }
}

aiAssignment

Description

Fetch a single assignment by public_id. Admin only.

Response

Returns an AiAssignment

Arguments
Name Description
id - String!

Example

Query
query aiAssignment($id: String!) {
  aiAssignment(id: $id) {
    chatSession {
      ...AiChatSessionFragment
    }
    comments {
      ...AiAssignmentCommentFragment
    }
    createdAt
    createdBy {
      ...AiRunRequesterFragment
    }
    description
    id
    owner {
      ...AiEmployeeFragment
    }
    parent {
      ...AiAssignmentFragment
    }
    runs {
      ...AiRunFragment
    }
    source
    status
    title
    updatedAt
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "aiAssignment": {
      "chatSession": AiChatSession,
      "comments": [AiAssignmentComment],
      "createdAt": ISO8601DateTime,
      "createdBy": AiRunRequester,
      "description": "xyz789",
      "id": "xyz789",
      "owner": AiEmployee,
      "parent": AiAssignment,
      "runs": [AiRun],
      "source": "xyz789",
      "status": "abc123",
      "title": "abc123",
      "updatedAt": ISO8601DateTime
    }
  }
}

aiAssignments

Description

Assignments for a crew, newest first. Each groups one task's runs, including retries and revisions. Non-admins only see their own crews.

Response

Returns an AiAssignmentConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
crew - String Default = "marketing"
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
ownerId - ID public_id of the owning agent.
status - String todo, working, waiting_on_admin, done or cancelled.

Example

Query
query aiAssignments(
  $after: String,
  $before: String,
  $crew: String,
  $first: Int,
  $last: Int,
  $ownerId: ID,
  $status: String
) {
  aiAssignments(
    after: $after,
    before: $before,
    crew: $crew,
    first: $first,
    last: $last,
    ownerId: $ownerId,
    status: $status
  ) {
    edges {
      ...AiAssignmentEdgeFragment
    }
    nodes {
      ...AiAssignmentFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "crew": "marketing",
  "first": 987,
  "last": 123,
  "ownerId": "4",
  "status": "xyz789"
}
Response
{
  "data": {
    "aiAssignments": {
      "edges": [AiAssignmentEdge],
      "nodes": [AiAssignment],
      "pageInfo": PageInfo
    }
  }
}

aiAutopilots

Description

Autopilots, newest first, optionally for one agent. Non-admins only see the marketing crew's.

Response

Returns [AiAutopilot!]!

Arguments
Name Description
agentId - ID public_id of the agent.
triggerType - String schedule (default) or event.

Example

Query
query aiAutopilots(
  $agentId: ID,
  $triggerType: String
) {
  aiAutopilots(
    agentId: $agentId,
    triggerType: $triggerType
  ) {
    active
    aiEmployee {
      ...AiEmployeeFragment
    }
    cooldownSeconds
    eventKind
    filter
    id
    instructions
    lastRun {
      ...AiRunFragment
    }
    lastRunAt
    name
    nextRunAt
    postsPerRun
    scheduleCron
    timeZone
    triggerType
  }
}
Variables
{"agentId": 4, "triggerType": "abc123"}
Response
{
  "data": {
    "aiAutopilots": [
      {
        "active": false,
        "aiEmployee": AiEmployee,
        "cooldownSeconds": 123,
        "eventKind": "abc123",
        "filter": {},
        "id": "abc123",
        "instructions": "xyz789",
        "lastRun": AiRun,
        "lastRunAt": ISO8601DateTime,
        "name": "xyz789",
        "nextRunAt": ISO8601DateTime,
        "postsPerRun": 123,
        "scheduleCron": "xyz789",
        "timeZone": "xyz789",
        "triggerType": "xyz789"
      }
    ]
  }
}

aiChatSession

Description

Fetch a single chat session by public_id. The caller's own, or null.

Response

Returns an AiChatSession

Arguments
Name Description
id - String!

Example

Query
query aiChatSession($id: String!) {
  aiChatSession(id: $id) {
    activeRunStatus
    agent {
      ...AiEmployeeFragment
    }
    assignments {
      ...AiAssignmentFragment
    }
    costCents
    createdAt
    id
    lastMessageAt
    messages {
      ...AiChatMessageFragment
    }
    title
    viewerIsOwner
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "aiChatSession": {
      "activeRunStatus": "abc123",
      "agent": AiEmployee,
      "assignments": [AiAssignment],
      "costCents": 123,
      "createdAt": ISO8601DateTime,
      "id": "xyz789",
      "lastMessageAt": ISO8601DateTime,
      "messages": [AiChatMessage],
      "title": "xyz789",
      "viewerIsOwner": true
    }
  }
}

aiChatSessions

Description

The caller's own chat sessions with one agent, newest lastMessageAt first (OBJ-5714).

Response

Returns [AiChatSession!]!

Arguments
Name Description
agentId - String!
first - Int

Example

Query
query aiChatSessions(
  $agentId: String!,
  $first: Int
) {
  aiChatSessions(
    agentId: $agentId,
    first: $first
  ) {
    activeRunStatus
    agent {
      ...AiEmployeeFragment
    }
    assignments {
      ...AiAssignmentFragment
    }
    costCents
    createdAt
    id
    lastMessageAt
    messages {
      ...AiChatMessageFragment
    }
    title
    viewerIsOwner
  }
}
Variables
{"agentId": "abc123", "first": 987}
Response
{
  "data": {
    "aiChatSessions": [
      {
        "activeRunStatus": "xyz789",
        "agent": AiEmployee,
        "assignments": [AiAssignment],
        "costCents": 987,
        "createdAt": ISO8601DateTime,
        "id": "abc123",
        "lastMessageAt": ISO8601DateTime,
        "messages": [AiChatMessage],
        "title": "abc123",
        "viewerIsOwner": true
      }
    ]
  }
}

aiEmployee

Description

Fetch a single AI employee by public_id. Admin only.

Response

Returns an AiEmployee

Arguments
Name Description
id - String!

Example

Query
query aiEmployee($id: String!) {
  aiEmployee(id: $id) {
    active
    aiEmployeeMemories {
      ...AiEmployeeMemoryFragment
    }
    aiRuns {
      ...AiRunFragment
    }
    approvalRateData {
      ...ApprovalRateDataFragment
    }
    archived
    autonomyLevel
    channels
    crew
    currentMonthCost
    description
    dispatchBlockReason
    id
    lastRun {
      ...AiRunFragment
    }
    mcpServers
    modelPreference
    monthlyBudgetCents
    name
    nextRunAt
    nextTrigger {
      ...AiEmployeeNextTriggerFragment
    }
    outputKind
    postFilterSkill
    postPerformance {
      ...PostPerformanceFragment
    }
    promotionCriteria {
      ...PromotionCriteriaFragment
    }
    roleKey
    scheduleCron
    skillRefs
    stats {
      ...AiEmployeeStatsFragment
    }
    taskPrompt
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "aiEmployee": {
      "active": false,
      "aiEmployeeMemories": [AiEmployeeMemory],
      "aiRuns": [AiRun],
      "approvalRateData": [ApprovalRateData],
      "archived": false,
      "autonomyLevel": "abc123",
      "channels": ["abc123"],
      "crew": "xyz789",
      "currentMonthCost": 123,
      "description": "xyz789",
      "dispatchBlockReason": "xyz789",
      "id": "xyz789",
      "lastRun": AiRun,
      "mcpServers": ["xyz789"],
      "modelPreference": "xyz789",
      "monthlyBudgetCents": 987,
      "name": "xyz789",
      "nextRunAt": ISO8601DateTime,
      "nextTrigger": AiEmployeeNextTrigger,
      "outputKind": "abc123",
      "postFilterSkill": "abc123",
      "postPerformance": PostPerformance,
      "promotionCriteria": PromotionCriteria,
      "roleKey": "abc123",
      "scheduleCron": "abc123",
      "skillRefs": ["xyz789"],
      "stats": AiEmployeeStats,
      "taskPrompt": "xyz789"
    }
  }
}

aiEmployees

Description

Admin only. AI employee list, cursor-paginated.

Response

Returns an AiEmployeeConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
autonomy - String
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
roleKey - String
status - String

Example

Query
query aiEmployees(
  $after: String,
  $autonomy: String,
  $before: String,
  $first: Int,
  $last: Int,
  $roleKey: String,
  $status: String
) {
  aiEmployees(
    after: $after,
    autonomy: $autonomy,
    before: $before,
    first: $first,
    last: $last,
    roleKey: $roleKey,
    status: $status
  ) {
    edges {
      ...AiEmployeeEdgeFragment
    }
    nodes {
      ...AiEmployeeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "autonomy": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987,
  "roleKey": "abc123",
  "status": "xyz789"
}
Response
{
  "data": {
    "aiEmployees": {
      "edges": [AiEmployeeEdge],
      "nodes": [AiEmployee],
      "pageInfo": PageInfo
    }
  }
}

aiInbox

Description

Typed AI Workforce inbox items derived from the last 30 days of activity, newest first, cursor-paginated. Non-admins only see their own crews.

Response

Returns an AiInboxItemConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
includeArchived - Boolean Default = false
includeResolved - Boolean Default = true
last - Int Returns the last n elements from the list.
types - [String!] assigned, waiting, failed, delivered or replied.

Example

Query
query aiInbox(
  $after: String,
  $before: String,
  $first: Int,
  $includeArchived: Boolean,
  $includeResolved: Boolean,
  $last: Int,
  $types: [String!]
) {
  aiInbox(
    after: $after,
    before: $before,
    first: $first,
    includeArchived: $includeArchived,
    includeResolved: $includeResolved,
    last: $last,
    types: $types
  ) {
    edges {
      ...AiInboxItemEdgeFragment
    }
    nodes {
      ...AiInboxItemFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "includeArchived": false,
  "includeResolved": true,
  "last": 123,
  "types": ["abc123"]
}
Response
{
  "data": {
    "aiInbox": {
      "edges": [AiInboxItemEdge],
      "nodes": [AiInboxItem],
      "pageInfo": PageInfo
    }
  }
}

aiInboxCounts

Description

Inbox header counts for the current viewer.

Response

Returns an AiInboxCounts!

Example

Query
query aiInboxCounts {
  aiInboxCounts {
    actionable
    byType {
      ...AiInboxTypeCountFragment
    }
  }
}
Response
{
  "data": {
    "aiInboxCounts": {
      "actionable": 987,
      "byType": [AiInboxTypeCount]
    }
  }
}

aiRequest

Description

Fetch a single async AiRequest by public_id. Owning user only; the reconnect-recovery counterpart to aiRequestUpdate (v4.60 Phase 1).

Response

Returns an AiRequest

Arguments
Name Description
id - ID! public_id of the AiRequest to retrieve.

Example

Query
query aiRequest($id: ID!) {
  aiRequest(id: $id) {
    completedAt
    createdAt
    errorCode
    errorMessage
    id
    kind
    resultJson
    status
    steps
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "aiRequest": {
      "completedAt": ISO8601DateTime,
      "createdAt": ISO8601DateTime,
      "errorCode": "abc123",
      "errorMessage": "xyz789",
      "id": "4",
      "kind": "xyz789",
      "resultJson": "xyz789",
      "status": "abc123",
      "steps": ["abc123"]
    }
  }
}

aiReviewBatches

Description

Runs that produced artifacts, newest first, each with its artifacts, revision chains, delivery status and counts. Revision runs are folded into the artifact they revise. Non-admins only see the marketing crew.

Response

Returns an AiRunConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
allCrews - Boolean Every crew the caller can see (admins: all crews; others: marketing). Overrides crew. Default = false
before - String Returns the elements in the list that come before the specified cursor.
crew - String Default = "marketing"
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
needsReview - Boolean Only runs with at least one pending artifact that needs a decision (reports and recommendations are FYI).
runId - ID Just this run.

Example

Query
query aiReviewBatches(
  $after: String,
  $allCrews: Boolean,
  $before: String,
  $crew: String,
  $first: Int,
  $last: Int,
  $needsReview: Boolean,
  $runId: ID
) {
  aiReviewBatches(
    after: $after,
    allCrews: $allCrews,
    before: $before,
    crew: $crew,
    first: $first,
    last: $last,
    needsReview: $needsReview,
    runId: $runId
  ) {
    edges {
      ...AiRunEdgeFragment
    }
    nodes {
      ...AiRunFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "allCrews": false,
  "before": "abc123",
  "crew": "marketing",
  "first": 123,
  "last": 987,
  "needsReview": true,
  "runId": "4"
}
Response
{
  "data": {
    "aiReviewBatches": {
      "edges": [AiRunEdge],
      "nodes": [AiRun],
      "pageInfo": PageInfo
    }
  }
}

aiRun

Description

Fetch a single AI run by public_id. Admin only.

Response

Returns an AiRun

Arguments
Name Description
id - String!

Example

Query
query aiRun($id: String!) {
  aiRun(id: $id) {
    aiArtifacts {
      ...AiArtifactFragment
    }
    aiEmployee {
      ...AiEmployeeFragment
    }
    artifactCounts {
      ...AiArtifactCountsFragment
    }
    assignment {
      ...AiAssignmentFragment
    }
    autoRetry {
      ...AiRunFragment
    }
    autopilot {
      ...AiAutopilotFragment
    }
    completionTokens
    costCents
    createdAt
    dueOn
    durationSeconds
    errorMessage
    failureReason
    finishedAt
    id
    instructions
    numTurns
    promptTokens
    requestedBy {
      ...AiRunRequesterFragment
    }
    retryOf {
      ...AiRunFragment
    }
    runLog
    skipReason
    startedAt
    status
    steps {
      ...AiRunStepFragment
    }
    title
    triggeredBy
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "aiRun": {
      "aiArtifacts": [AiArtifact],
      "aiEmployee": AiEmployee,
      "artifactCounts": AiArtifactCounts,
      "assignment": AiAssignment,
      "autoRetry": AiRun,
      "autopilot": AiAutopilot,
      "completionTokens": 987,
      "costCents": 987,
      "createdAt": ISO8601DateTime,
      "dueOn": ISO8601Date,
      "durationSeconds": 987,
      "errorMessage": "xyz789",
      "failureReason": "xyz789",
      "finishedAt": ISO8601DateTime,
      "id": "abc123",
      "instructions": "abc123",
      "numTurns": 987,
      "promptTokens": 987,
      "requestedBy": AiRunRequester,
      "retryOf": AiRun,
      "runLog": {},
      "skipReason": "abc123",
      "startedAt": ISO8601DateTime,
      "status": "abc123",
      "steps": [AiRunStep],
      "title": "xyz789",
      "triggeredBy": "xyz789"
    }
  }
}

aiTasks

Description

One-off tasks and autopilot runs for a crew, newest first. Non-admins only see the marketing crew. Each run belongs to an assignment (aiAssignments), which groups a task's retries and revisions.

Response

Returns an AiRunConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
crew - String Default = "marketing"
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query aiTasks(
  $after: String,
  $before: String,
  $crew: String,
  $first: Int,
  $last: Int
) {
  aiTasks(
    after: $after,
    before: $before,
    crew: $crew,
    first: $first,
    last: $last
  ) {
    edges {
      ...AiRunEdgeFragment
    }
    nodes {
      ...AiRunFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "crew": "marketing",
  "first": 987,
  "last": 987
}
Response
{
  "data": {
    "aiTasks": {
      "edges": [AiRunEdge],
      "nodes": [AiRun],
      "pageInfo": PageInfo
    }
  }
}

aiTriggerEventKinds

Description

Event kinds an autopilot can trigger on, each with the filter shape the server validates against (AiAutopilot::EVENT_FILTER_SCHEMAS). Same access gate as aiAutopilots.

Response

Returns [AiTriggerEventKind!]!

Example

Query
query aiTriggerEventKinds {
  aiTriggerEventKinds {
    filterFields {
      ...AiTriggerEventFilterFieldFragment
    }
    kind
    label
  }
}
Response
{
  "data": {
    "aiTriggerEventKinds": [
      {
        "filterFields": [AiTriggerEventFilterField],
        "kind": "abc123",
        "label": "xyz789"
      }
    ]
  }
}

aiWorkforceEvents

Description

Append-only AI Workforce activity log (OBJ-5674), newest first, cursor-paginated. Non-admins only see their own crews.

Response

Returns an AiWorkforceEventConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
employeeId - ID
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query aiWorkforceEvents(
  $after: String,
  $before: String,
  $employeeId: ID,
  $first: Int,
  $last: Int
) {
  aiWorkforceEvents(
    after: $after,
    before: $before,
    employeeId: $employeeId,
    first: $first,
    last: $last
  ) {
    edges {
      ...AiWorkforceEventEdgeFragment
    }
    nodes {
      ...AiWorkforceEventFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "employeeId": 4,
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "aiWorkforceEvents": {
      "edges": [AiWorkforceEventEdge],
      "nodes": [AiWorkforceEvent],
      "pageInfo": PageInfo
    }
  }
}

allyActivityFeed

Description

Returns paginated activity events from the current user's accepted allies. Each item carries a kind discriminator (GOAL / JOIN / POST / ACHIEVEMENT / FOLLOW) and a per-kind details payload.

Response

Returns [AllyActivity!]

Arguments
Name Description
limit - Int Maximum number of events to return. Defaults to 20, capped at 50.
offset - Int Number of items to skip for pagination. Defaults to 0.
userId - ID! public_id of the user whose ally feed to retrieve.

Example

Query
query allyActivityFeed(
  $limit: Int,
  $offset: Int,
  $userId: ID!
) {
  allyActivityFeed(
    limit: $limit,
    offset: $offset,
    userId: $userId
  ) {
    action
    allyId
    allyName
    allyPhoto
    communityId
    communityName
    details
    id
    kind
    loggedLate
    target
    timestamp
  }
}
Variables
{"limit": 987, "offset": 987, "userId": "4"}
Response
{
  "data": {
    "allyActivityFeed": [
      {
        "action": "abc123",
        "allyId": "4",
        "allyName": "xyz789",
        "allyPhoto": "xyz789",
        "communityId": "4",
        "communityName": "abc123",
        "details": {},
        "id": "4",
        "kind": "ACHIEVEMENT",
        "loggedLate": true,
        "target": "abc123",
        "timestamp": "abc123"
      }
    ]
  }
}

allyInvitePreview

Description

Public preview of an invite token — returns inviter name, avatar, and validity. No auth required. Rate-limited (60 req/min per IP for anonymous callers; per user when authenticated.).

Response

Returns an AllyInvitePreview!

Arguments
Name Description
token - String! Invite token from the deep link.

Example

Query
query allyInvitePreview($token: String!) {
  allyInvitePreview(token: $token) {
    invalidReason
    inviterAvatarUrl
    inviterName
    valid
  }
}
Variables
{"token": "abc123"}
Response
{
  "data": {
    "allyInvitePreview": {
      "invalidReason": "xyz789",
      "inviterAvatarUrl": "abc123",
      "inviterName": "xyz789",
      "valid": false
    }
  }
}

askDocsQuestion

Description

Ask a question about the Objectuve engineering docs corpus. Requires a Clerk session on an @objectuve.com email, verified server-side. Rate-limited 20 req/min per user. Returns DISABLED (not an error) when the assistant is off.

Response

Returns a DocsAssistantAnswer!

Arguments
Name Description
question - String! The question to ask the docs assistant.

Example

Query
query askDocsQuestion($question: String!) {
  askDocsQuestion(question: $question) {
    answer
    citations {
      ...DocsAssistantCitationFragment
    }
    state
  }
}
Variables
{"question": "xyz789"}
Response
{
  "data": {
    "askDocsQuestion": {
      "answer": "xyz789",
      "citations": [DocsAssistantCitation],
      "state": "ANSWERED"
    }
  }
}

askGuideQuestion

Description

Ask a question about the Objectuve guide. No auth required. Rate-limited (20 req/min per IP for anonymous callers; per user when authenticated). Returns DISABLED (not an error) when the assistant is off.

Response

Returns a GuideAssistantAnswer!

Arguments
Name Description
question - String! The question to ask the guide assistant.

Example

Query
query askGuideQuestion($question: String!) {
  askGuideQuestion(question: $question) {
    answer
    citations {
      ...GuideAssistantCitationFragment
    }
    state
  }
}
Variables
{"question": "abc123"}
Response
{
  "data": {
    "askGuideQuestion": {
      "answer": "xyz789",
      "citations": [GuideAssistantCitation],
      "state": "ANSWERED"
    }
  }
}

authzCheck

Description

Checks whether the current user has a specific permission (e.g. admin).

Response

Returns a Result

Arguments
Name Description
concern - String! Permission name to check (e.g. "admin").
id - ID! public_id of the user to check authorization for.

Example

Query
query authzCheck(
  $concern: String!,
  $id: ID!
) {
  authzCheck(
    concern: $concern,
    id: $id
  ) {
    success
  }
}
Variables
{"concern": "xyz789", "id": 4}
Response
{"data": {"authzCheck": {"success": true}}}

badgeHolderCount

Description

Public. Distinct number of real (non-demo) users, other than the viewer, who have unlocked a given badge. Returns 0 for unknown keys (validated against the BadgeCatalog allowlist). Cached for 1 hour.

Response

Returns an Int!

Arguments
Name Description
badgeKey - String! Badge key from Gamification::BadgeCatalog::BADGE_KEYS.

Example

Query
query badgeHolderCount($badgeKey: String!) {
  badgeHolderCount(badgeKey: $badgeKey)
}
Variables
{"badgeKey": "abc123"}
Response
{"data": {"badgeHolderCount": 987}}

badgeStats

Description

Returns the unlock percentage for each badge across all users. Cached for 1 hour.

Response

Returns [BadgeStat!]

Example

Query
query badgeStats {
  badgeStats {
    badgeKey
    percentage
  }
}
Response
{
  "data": {
    "badgeStats": [
      {
        "badgeKey": "xyz789",
        "percentage": 123.45
      }
    ]
  }
}

blockedUsers

Description

Returns the authenticated user's blocked set (either direction — a block hides content symmetrically). Auth required.

Response

Returns [UserSearchResult!]!

Example

Query
query blockedUsers {
  blockedUsers {
    achievementStats {
      ...AchievementStatsFragment
    }
    actions {
      ...UserActionFragment
    }
    admin
    adminRoles
    allyStatus
    badgeActions {
      ...UserActionFragment
    }
    celebrationPreferences {
      ...CelebrationPreferencesFragment
    }
    charterMarkerHidden
    charterMemberSince
    charterNotesEnabled
    coachingPreferences {
      ...CoachingPreferencesFragment
    }
    colorTheme
    completedCommunityChallenges {
      ...ChallengeParticipantFragment
    }
    completedSeasonalEvents {
      ...SeasonalEventParticipantFragment
    }
    createdAtTime
    currentInsights {
      ...InsightPackFragment
    }
    dashboardPreferences {
      ...DashboardPreferencesFragment
    }
    dayClosedToday
    daysShownUp
    daysSinceLastActive
    demo
    details {
      ...UserDetailFragment
    }
    email
    emailVerified
    featureTourStatus
    feedItems {
      ...UserFeedItemFragment
    }
    firstName
    goItAlone
    goalDayContext {
      ...GoalDayContextFragment
    }
    goalDayLog {
      ...GoalDayLogEntryFragment
    }
    goalDaySummaries {
      ...GoalDaySummaryFragment
    }
    goalMotivationProfile {
      ...GoalMotivationProfileFragment
    }
    goals {
      ...GoalFragment
    }
    graceDays
    hasAlly
    hasCreatedFromTemplate
    hasDigestEnabled
    isSupporter
    lastDigestSentAt
    lastName
    latestEnneagramAssessment {
      ...EnneagramAssessmentFragment
    }
    level
    longestStreak
    moodGoalInsight {
      ...InsightPackFragment
    }
    nextLevelThreshold
    nextOnTheShelfBadge {
      ...NextBadgeFragment
    }
    notifications {
      ...UserNotificationFragment
    }
    onboardingStatus {
      ...OnboardingStatusFragment
    }
    paceSuggestion {
      ...PaceSuggestionFragment
    }
    photo {
      ...UserPhotoFragment
    }
    practiceInviteDismissedAt
    privateMode
    progressToNextLevel
    publicId
    recentlyUnlockedBadges {
      ...RecentlyUnlockedBadgeFragment
    }
    requiredCheckinsCompleteToday
    reverseNudge {
      ...ReverseNudgeFragment
    }
    showcasedAchievements
    signInDates
    signupAgeDays
    stats {
      ...UserStatsFragment
    }
    streak
    streakJourney {
      ...StreakJourneyFragment
    }
    streakRecountNotePending
    streakRepairOffer {
      ...StreakRepairOfferFragment
    }
    streakRescueDays {
      ...StreakRescueDayFragment
    }
    supporterCancelAtPeriodEnd
    supporterMoments {
      ...SupporterMomentsFragment
    }
    supporterTier
    supporterUntil
    timeToFirstGoalSeconds
    todaysMood
    unlockedAchievementKeys
    updatedAtTime
    username
    welcomeBackOffer {
      ...WelcomeBackOfferFragment
    }
    xp
  }
}
Response
{
  "data": {
    "blockedUsers": [
      {
        "achievementStats": AchievementStats,
        "actions": [UserAction],
        "admin": false,
        "adminRoles": ["xyz789"],
        "allyStatus": "ACCEPTED",
        "badgeActions": [UserAction],
        "celebrationPreferences": CelebrationPreferences,
        "charterMarkerHidden": false,
        "charterMemberSince": ISO8601DateTime,
        "charterNotesEnabled": true,
        "coachingPreferences": CoachingPreferences,
        "colorTheme": "xyz789",
        "completedCommunityChallenges": [
          ChallengeParticipant
        ],
        "completedSeasonalEvents": [
          SeasonalEventParticipant
        ],
        "createdAtTime": "xyz789",
        "currentInsights": [InsightPack],
        "dashboardPreferences": DashboardPreferences,
        "dayClosedToday": false,
        "daysShownUp": 123,
        "daysSinceLastActive": 123,
        "demo": true,
        "details": UserDetail,
        "email": "xyz789",
        "emailVerified": true,
        "featureTourStatus": {},
        "feedItems": [UserFeedItem],
        "firstName": "xyz789",
        "goItAlone": true,
        "goalDayContext": GoalDayContext,
        "goalDayLog": [GoalDayLogEntry],
        "goalDaySummaries": [GoalDaySummary],
        "goalMotivationProfile": GoalMotivationProfile,
        "goals": [Goal],
        "graceDays": ["abc123"],
        "hasAlly": true,
        "hasCreatedFromTemplate": true,
        "hasDigestEnabled": false,
        "isSupporter": false,
        "lastDigestSentAt": "abc123",
        "lastName": "xyz789",
        "latestEnneagramAssessment": EnneagramAssessment,
        "level": 987,
        "longestStreak": 123,
        "moodGoalInsight": InsightPack,
        "nextLevelThreshold": 123,
        "nextOnTheShelfBadge": NextBadge,
        "notifications": [UserNotification],
        "onboardingStatus": OnboardingStatus,
        "paceSuggestion": PaceSuggestion,
        "photo": UserPhoto,
        "practiceInviteDismissedAt": "abc123",
        "privateMode": false,
        "progressToNextLevel": 987.65,
        "publicId": 4,
        "recentlyUnlockedBadges": [RecentlyUnlockedBadge],
        "requiredCheckinsCompleteToday": true,
        "reverseNudge": ReverseNudge,
        "showcasedAchievements": ["xyz789"],
        "signInDates": ["xyz789"],
        "signupAgeDays": 987,
        "stats": UserStats,
        "streak": 123,
        "streakJourney": StreakJourney,
        "streakRecountNotePending": false,
        "streakRepairOffer": StreakRepairOffer,
        "streakRescueDays": [StreakRescueDay],
        "supporterCancelAtPeriodEnd": true,
        "supporterMoments": SupporterMoments,
        "supporterTier": "abc123",
        "supporterUntil": ISO8601DateTime,
        "timeToFirstGoalSeconds": 987,
        "todaysMood": "abc123",
        "unlockedAchievementKeys": [
          "xyz789"
        ],
        "updatedAtTime": "abc123",
        "username": "abc123",
        "welcomeBackOffer": WelcomeBackOffer,
        "xp": 987
      }
    ]
  }
}

coachConversation

Description

Returns the persisted Coach conversation thread for the authenticated user. Scoped per goal if goal_id is provided; returns the global thread otherwise. With coach_single_conversation_enabled on, goal_id is ignored and the thread is always the single main conversation, whose messages are the union of the user's live history (v4.127 D10).

Response

Returns a CoachConversation

Example

Query
query coachConversation {
  coachConversation {
    goalId
    id
    lastMessageAt
    messages {
      ...CoachMessageFragment
    }
  }
}
Response
{
  "data": {
    "coachConversation": {
      "goalId": "abc123",
      "id": "abc123",
      "lastMessageAt": ISO8601DateTime,
      "messages": [CoachMessage]
    }
  }
}

coachGoalSuggestionsPreferences

Description

Returns whether Coach may suggest goal changes in chat for the authenticated user. Requires auth.

Example

Query
query coachGoalSuggestionsPreferences {
  coachGoalSuggestionsPreferences {
    enabled
  }
}
Response
{"data": {"coachGoalSuggestionsPreferences": {"enabled": true}}}

coachModelSetting

Description

Returns the runtime Coach Gemini model setting: current value, allowlisted options with current rates, and the last 5 changes. Admin only.

Response

Returns a CoachModelSetting!

Example

Query
query coachModelSetting {
  coachModelSetting {
    currentModel
    options {
      ...CoachModelOptionFragment
    }
    recentChanges {
      ...CoachModelChangeFragment
    }
  }
}
Response
{
  "data": {
    "coachModelSetting": {
      "currentModel": "abc123",
      "options": [CoachModelOption],
      "recentChanges": [CoachModelChange]
    }
  }
}

communities

Description

Lists communities, optionally filtered by user membership or goal category.

Response

Returns [Community!]

Arguments
Name Description
goalCategoryIds - [ID!] Array of goal category IDs to filter communities by.
userId - ID public_id of a user to return only communities they are a member of.

Example

Query
query communities(
  $goalCategoryIds: [ID!],
  $userId: ID
) {
  communities(
    goalCategoryIds: $goalCategoryIds,
    userId: $userId
  ) {
    activeChallenge {
      ...CommunityChallengeFragment
    }
    activeMembers
    archiveDaysLeft
    archivedAt
    badges {
      ...CommunityBadgesFragment
    }
    category
    checkInsPerWeek
    coverImage
    createdAt
    createdAtTime
    demo
    description
    editorialPosition
    editorialSlot
    feedItems {
      ...CommunityFeedItemFragment
    }
    goalCategory {
      ...GoalCategoryFragment
    }
    goals {
      ...GoalFragment
    }
    growthRate
    guidelines
    healthScore
    icon
    id
    imageUrl
    isDefault
    isDefaultForTeam
    isFeatured
    isFounding
    isGated
    isMember
    isVerified
    joinPolicy
    leadMembershipId
    leadName
    memberCount
    members {
      ...CommunityMemberFragment
    }
    membersToDiscoverable
    name
    pastChallenges {
      ...CommunityChallengeFragment
    }
    privacy
    private
    publicId
    reason {
      ...CommunityReasonFragment
    }
    teamId
    teamName
    totalGoals
    upcomingChallenges {
      ...CommunityChallengeFragment
    }
    upcomingEvents {
      ...CommunityEventFragment
    }
    updatedAtTime
    userProgressPercent
    viewerCanCreateEvents
    viewerDigest {
      ...CommunityViewerDigestFragment
    }
  }
}
Variables
{"goalCategoryIds": ["4"], "userId": 4}
Response
{
  "data": {
    "communities": [
      {
        "activeChallenge": CommunityChallenge,
        "activeMembers": 987,
        "archiveDaysLeft": 987,
        "archivedAt": ISO8601DateTime,
        "badges": CommunityBadges,
        "category": "xyz789",
        "checkInsPerWeek": 987,
        "coverImage": "xyz789",
        "createdAt": ISO8601DateTime,
        "createdAtTime": "xyz789",
        "demo": true,
        "description": "abc123",
        "editorialPosition": 123,
        "editorialSlot": "xyz789",
        "feedItems": [CommunityFeedItem],
        "goalCategory": GoalCategory,
        "goals": [Goal],
        "growthRate": 123.45,
        "guidelines": "abc123",
        "healthScore": 987,
        "icon": "xyz789",
        "id": "4",
        "imageUrl": "abc123",
        "isDefault": true,
        "isDefaultForTeam": true,
        "isFeatured": true,
        "isFounding": true,
        "isGated": false,
        "isMember": true,
        "isVerified": true,
        "joinPolicy": "abc123",
        "leadMembershipId": 4,
        "leadName": "abc123",
        "memberCount": 987,
        "members": [CommunityMember],
        "membersToDiscoverable": 123,
        "name": "abc123",
        "pastChallenges": [CommunityChallenge],
        "privacy": "abc123",
        "private": true,
        "publicId": 4,
        "reason": CommunityReason,
        "teamId": "4",
        "teamName": "abc123",
        "totalGoals": 987,
        "upcomingChallenges": [CommunityChallenge],
        "upcomingEvents": [CommunityEvent],
        "updatedAtTime": "xyz789",
        "userProgressPercent": 123.45,
        "viewerCanCreateEvents": false,
        "viewerDigest": CommunityViewerDigest
      }
    ]
  }
}

community

Description

Fetches a community by its public_id. Authorization: For a team-scoped room (teamId present), requires an actual CommunityMember record — seated team membership alone is not enough. Admins bypass. teamId-nil (public/free) communities are unaffected. See Communities § Room Access Boundary.

Response

Returns a Community

Arguments
Name Description
id - ID! public_id of the community to retrieve.

Example

Query
query community($id: ID!) {
  community(id: $id) {
    activeChallenge {
      ...CommunityChallengeFragment
    }
    activeMembers
    archiveDaysLeft
    archivedAt
    badges {
      ...CommunityBadgesFragment
    }
    category
    checkInsPerWeek
    coverImage
    createdAt
    createdAtTime
    demo
    description
    editorialPosition
    editorialSlot
    feedItems {
      ...CommunityFeedItemFragment
    }
    goalCategory {
      ...GoalCategoryFragment
    }
    goals {
      ...GoalFragment
    }
    growthRate
    guidelines
    healthScore
    icon
    id
    imageUrl
    isDefault
    isDefaultForTeam
    isFeatured
    isFounding
    isGated
    isMember
    isVerified
    joinPolicy
    leadMembershipId
    leadName
    memberCount
    members {
      ...CommunityMemberFragment
    }
    membersToDiscoverable
    name
    pastChallenges {
      ...CommunityChallengeFragment
    }
    privacy
    private
    publicId
    reason {
      ...CommunityReasonFragment
    }
    teamId
    teamName
    totalGoals
    upcomingChallenges {
      ...CommunityChallengeFragment
    }
    upcomingEvents {
      ...CommunityEventFragment
    }
    updatedAtTime
    userProgressPercent
    viewerCanCreateEvents
    viewerDigest {
      ...CommunityViewerDigestFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "community": {
      "activeChallenge": CommunityChallenge,
      "activeMembers": 123,
      "archiveDaysLeft": 987,
      "archivedAt": ISO8601DateTime,
      "badges": CommunityBadges,
      "category": "abc123",
      "checkInsPerWeek": 987,
      "coverImage": "xyz789",
      "createdAt": ISO8601DateTime,
      "createdAtTime": "abc123",
      "demo": true,
      "description": "abc123",
      "editorialPosition": 123,
      "editorialSlot": "abc123",
      "feedItems": [CommunityFeedItem],
      "goalCategory": GoalCategory,
      "goals": [Goal],
      "growthRate": 987.65,
      "guidelines": "abc123",
      "healthScore": 123,
      "icon": "abc123",
      "id": "4",
      "imageUrl": "abc123",
      "isDefault": false,
      "isDefaultForTeam": false,
      "isFeatured": true,
      "isFounding": false,
      "isGated": true,
      "isMember": false,
      "isVerified": true,
      "joinPolicy": "abc123",
      "leadMembershipId": "4",
      "leadName": "xyz789",
      "memberCount": 123,
      "members": [CommunityMember],
      "membersToDiscoverable": 987,
      "name": "xyz789",
      "pastChallenges": [CommunityChallenge],
      "privacy": "abc123",
      "private": true,
      "publicId": 4,
      "reason": CommunityReason,
      "teamId": 4,
      "teamName": "abc123",
      "totalGoals": 987,
      "upcomingChallenges": [CommunityChallenge],
      "upcomingEvents": [CommunityEvent],
      "updatedAtTime": "xyz789",
      "userProgressPercent": 123.45,
      "viewerCanCreateEvents": false,
      "viewerDigest": CommunityViewerDigest
    }
  }
}

communityBadges

Description

Returns the threshold and status marks for a community. Authorization: For a team-scoped room (teamId present), requires an actual CommunityMember record — seated team membership alone is not enough. Admins bypass. teamId-nil (public/free) communities are unaffected. See Communities § Room Access Boundary.

Response

Returns a CommunityBadges

Arguments
Name Description
communityId - ID! public_id of the community.

Example

Query
query communityBadges($communityId: ID!) {
  communityBadges(communityId: $communityId) {
    club1k
    featured
    streak100
    wins500
  }
}
Variables
{"communityId": 4}
Response
{
  "data": {
    "communityBadges": {
      "club1k": false,
      "featured": true,
      "streak100": true,
      "wins500": true
    }
  }
}

communityChallenge

Description

Fetches a community challenge by public_id.

Response

Returns a CommunityChallenge

Arguments
Name Description
id - ID! public_id of the challenge to retrieve.

Example

Query
query communityChallenge($id: ID!) {
  communityChallenge(id: $id) {
    badgeIcon
    badgeName
    community {
      ...CommunityFragment
    }
    createdAtTime
    creator {
      ...UserFragment
    }
    currentUserParticipant {
      ...ChallengeParticipantFragment
    }
    description
    endDate
    isParticipating
    name
    participantCount
    publicId
    startDate
    status
    targetGoalCount
    targetGoalType {
      ...GoalTypeFragment
    }
    updatedAtTime
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "communityChallenge": {
      "badgeIcon": "abc123",
      "badgeName": "abc123",
      "community": Community,
      "createdAtTime": "xyz789",
      "creator": User,
      "currentUserParticipant": ChallengeParticipant,
      "description": "abc123",
      "endDate": ISO8601Date,
      "isParticipating": true,
      "name": "abc123",
      "participantCount": 123,
      "publicId": 4,
      "startDate": ISO8601Date,
      "status": "abc123",
      "targetGoalCount": 123,
      "targetGoalType": GoalType,
      "updatedAtTime": "xyz789"
    }
  }
}

communityChallengeLeaderboard

Description

Paginated leaderboard for a challenge, ranked by progress_count DESC.

Response

Returns [ChallengeParticipant!]

Arguments
Name Description
challengeId - ID! public_id of the challenge.
completedOnly - Boolean When true, returns only participants who have completed the challenge.
limit - Int Number of participants to return. Defaults to 50.
offset - Int Number of participants to skip. Defaults to 0.

Example

Query
query communityChallengeLeaderboard(
  $challengeId: ID!,
  $completedOnly: Boolean,
  $limit: Int,
  $offset: Int
) {
  communityChallengeLeaderboard(
    challengeId: $challengeId,
    completedOnly: $completedOnly,
    limit: $limit,
    offset: $offset
  ) {
    communityChallenge {
      ...CommunityChallengeFragment
    }
    completed
    completedAt
    progressCount
    progressPercent
    publicId
    rank
    user {
      ...UserFragment
    }
    userPublicId
  }
}
Variables
{
  "challengeId": "4",
  "completedOnly": true,
  "limit": 123,
  "offset": 123
}
Response
{
  "data": {
    "communityChallengeLeaderboard": [
      {
        "communityChallenge": CommunityChallenge,
        "completed": false,
        "completedAt": ISO8601DateTime,
        "progressCount": 987,
        "progressPercent": 123.45,
        "publicId": "4",
        "rank": 987,
        "user": User,
        "userPublicId": "xyz789"
      }
    ]
  }
}

communityChallenges

Description

Lists challenges in a community, optionally filtered by status.

Response

Returns [CommunityChallenge!]

Arguments
Name Description
communityId - ID! public_id of the community.
status - String Filter by status: "active", "upcoming", or "completed". Omit for all.

Example

Query
query communityChallenges(
  $communityId: ID!,
  $status: String
) {
  communityChallenges(
    communityId: $communityId,
    status: $status
  ) {
    badgeIcon
    badgeName
    community {
      ...CommunityFragment
    }
    createdAtTime
    creator {
      ...UserFragment
    }
    currentUserParticipant {
      ...ChallengeParticipantFragment
    }
    description
    endDate
    isParticipating
    name
    participantCount
    publicId
    startDate
    status
    targetGoalCount
    targetGoalType {
      ...GoalTypeFragment
    }
    updatedAtTime
  }
}
Variables
{
  "communityId": "4",
  "status": "xyz789"
}
Response
{
  "data": {
    "communityChallenges": [
      {
        "badgeIcon": "xyz789",
        "badgeName": "xyz789",
        "community": Community,
        "createdAtTime": "abc123",
        "creator": User,
        "currentUserParticipant": ChallengeParticipant,
        "description": "abc123",
        "endDate": ISO8601Date,
        "isParticipating": false,
        "name": "xyz789",
        "participantCount": 123,
        "publicId": "4",
        "startDate": ISO8601Date,
        "status": "xyz789",
        "targetGoalCount": 123,
        "targetGoalType": GoalType,
        "updatedAtTime": "abc123"
      }
    ]
  }
}

communityFeed

Description

Returns the paginated post feed for a community, ordered by most recent. Authorization: For a team-scoped room (teamId present), requires an actual CommunityMember record — seated team membership alone is not enough. Admins bypass. teamId-nil (public/free) communities are unaffected. See Communities § Room Access Boundary.

Response

Returns [CommunityPost!]

Arguments
Name Description
communityId - ID! public_id of the community whose feed to retrieve.
limit - Int Number of posts to return per page. Defaults to 20.
offset - Int Number of posts to skip for pagination. Defaults to 0.

Example

Query
query communityFeed(
  $communityId: ID!,
  $limit: Int,
  $offset: Int
) {
  communityFeed(
    communityId: $communityId,
    limit: $limit,
    offset: $offset
  ) {
    comments {
      ...PostCommentFragment
    }
    communityId
    content
    goalId
    goalName
    id
    likes
    timestamp
    type
    userId
    userName
    userPhoto
  }
}
Variables
{"communityId": 4, "limit": 123, "offset": 987}
Response
{
  "data": {
    "communityFeed": [
      {
        "comments": [PostComment],
        "communityId": 4,
        "content": "xyz789",
        "goalId": "4",
        "goalName": "abc123",
        "id": 4,
        "likes": 987,
        "timestamp": "abc123",
        "type": "abc123",
        "userId": "4",
        "userName": "xyz789",
        "userPhoto": "xyz789"
      }
    ]
  }
}

communityGoals

Description

Returns paginated goals shared into a community. Authorization: For a team-scoped room (teamId present), requires an actual CommunityMember record — seated team membership alone is not enough. Admins bypass. teamId-nil (public/free) communities are unaffected. See Communities § Room Access Boundary.

Response

Returns [Goal!]

Arguments
Name Description
communityId - ID! public_id of the community.
limit - Int Number of goals to return. Defaults to 20.
offset - Int Number of goals to skip. Defaults to 0.

Example

Query
query communityGoals(
  $communityId: ID!,
  $limit: Int,
  $offset: Int
) {
  communityGoals(
    communityId: $communityId,
    limit: $limit,
    offset: $offset
  ) {
    allEvents {
      ...GoalEventFragment
    }
    appLink
    averageCheckInTime
    calendarMonth {
      ...GoalCalendarMonthFragment
    }
    category {
      ...GoalCategoryFragment
    }
    challenge {
      ...GoalChallengeFragment
    }
    chapters {
      ...GoalChapterFragment
    }
    checkedInToday
    collectiveGoalContribution {
      ...GoalCollectiveContributionFragment
    }
    comments {
      ...GoalEventCommentFragment
    }
    completed
    completedAtTime
    completionRate
    completionReflection
    content
    continuesGoal {
      ...GoalFragment
    }
    createdAtTime
    currentAmount
    dayOfWeekDistribution
    daysToUpdate
    demo
    dueToday
    durationMinutes
    encouragedBy {
      ...EncouragedByFragment
    }
    encouragements {
      ...GoalEventEncouragementFragment
    }
    events {
      ...GoalEventFragment
    }
    followersCount
    fromTemplate {
      ...GoalTemplateFragment
    }
    fromTemplateName
    habitCompletions {
      ...HabitCompletionFragment
    }
    habitStreak
    habitStreakUnit
    identityPrompt
    imageUrl
    journeyRecap {
      ...JourneyRecapFragment
    }
    kind {
      ...GoalTypeFragment
    }
    lastCheckedInDate
    lifeArea
    lockVersion
    longestHabitStreak
    milestones {
      ...GoalFragment
    }
    name
    nonAllyFollowersCount
    parentGoalId
    pastAttemptContext
    position
    practiceWeek {
      ...PracticeWeekFragment
    }
    practices {
      ...GoalFragment
    }
    preBreakHabitStreak
    private
    publicId
    quickUpdatePrompts
    recurrenceDays
    recurrenceInterval
    recurrenceType
    sharedWithPartner
    status
    streakFreezesAvailable
    streakFreezesUsed
    streakRepairEligibleUntil
    streakRepairedCount
    successorGoal {
      ...GoalFragment
    }
    successorOffer {
      ...SuccessorOfferFragment
    }
    supportsGoal {
      ...GoalFragment
    }
    targetAmount
    targetDateTime
    totalCheckIns
    unit
    updatedAtTime
    user {
      ...UserFragment
    }
    viewerCheeredToday
    visibility
    weeklyTarget
  }
}
Variables
{
  "communityId": "4",
  "limit": 987,
  "offset": 123
}
Response
{
  "data": {
    "communityGoals": [
      {
        "allEvents": [GoalEvent],
        "appLink": "xyz789",
        "averageCheckInTime": 123.45,
        "calendarMonth": GoalCalendarMonth,
        "category": GoalCategory,
        "challenge": GoalChallenge,
        "chapters": [GoalChapter],
        "checkedInToday": true,
        "collectiveGoalContribution": GoalCollectiveContribution,
        "comments": [GoalEventComment],
        "completed": true,
        "completedAtTime": "abc123",
        "completionRate": 987.65,
        "completionReflection": "xyz789",
        "content": "abc123",
        "continuesGoal": Goal,
        "createdAtTime": "abc123",
        "currentAmount": 123.45,
        "dayOfWeekDistribution": [987],
        "daysToUpdate": 987,
        "demo": false,
        "dueToday": false,
        "durationMinutes": 987,
        "encouragedBy": EncouragedBy,
        "encouragements": [GoalEventEncouragement],
        "events": [GoalEvent],
        "followersCount": 987,
        "fromTemplate": GoalTemplate,
        "fromTemplateName": "xyz789",
        "habitCompletions": [HabitCompletion],
        "habitStreak": 123,
        "habitStreakUnit": "DAY",
        "identityPrompt": "abc123",
        "imageUrl": "abc123",
        "journeyRecap": JourneyRecap,
        "kind": GoalType,
        "lastCheckedInDate": "abc123",
        "lifeArea": "xyz789",
        "lockVersion": 987,
        "longestHabitStreak": 987,
        "milestones": [Goal],
        "name": "xyz789",
        "nonAllyFollowersCount": 123,
        "parentGoalId": "abc123",
        "pastAttemptContext": "abc123",
        "position": 987,
        "practiceWeek": PracticeWeek,
        "practices": [Goal],
        "preBreakHabitStreak": 987,
        "private": false,
        "publicId": 4,
        "quickUpdatePrompts": ["abc123"],
        "recurrenceDays": ["abc123"],
        "recurrenceInterval": 123,
        "recurrenceType": "abc123",
        "sharedWithPartner": false,
        "status": "completed",
        "streakFreezesAvailable": 123,
        "streakFreezesUsed": 987,
        "streakRepairEligibleUntil": "abc123",
        "streakRepairedCount": 987,
        "successorGoal": Goal,
        "successorOffer": SuccessorOffer,
        "supportsGoal": Goal,
        "targetAmount": 987.65,
        "targetDateTime": "xyz789",
        "totalCheckIns": 123,
        "unit": "xyz789",
        "updatedAtTime": "abc123",
        "user": User,
        "viewerCheeredToday": false,
        "visibility": "ALLIES",
        "weeklyTarget": 987
      }
    ]
  }
}

communityInsights

Description

Returns community engagement insights and recommendations for a user.

Response

Returns a CommunityInsights

Arguments
Name Description
userId - ID! public_id of the user to generate insights for.

Example

Query
query communityInsights($userId: ID!) {
  communityInsights(userId: $userId) {
    achievementsUnlocked
    communitiesJoined
    hasGoalSignal
    partnersCount
    postsThisWeek
    suggestedCommunities {
      ...SuggestedCommunityFragment
    }
    suggestedCount
    totalEngagement
    trendingCommunities {
      ...TrendingCommunityFragment
    }
    upcomingEvents {
      ...CommunityEventFragment
    }
    yourActivity {
      ...UserActivityFragment
    }
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "communityInsights": {
      "achievementsUnlocked": 123,
      "communitiesJoined": 987,
      "hasGoalSignal": true,
      "partnersCount": 987,
      "postsThisWeek": 987,
      "suggestedCommunities": [SuggestedCommunity],
      "suggestedCount": 123,
      "totalEngagement": 123,
      "trendingCommunities": [TrendingCommunity],
      "upcomingEvents": [CommunityEvent],
      "yourActivity": [UserActivity]
    }
  }
}

communityMemberCheck

Description

Checks whether a given user is a member of a community.

Response

Returns a Result

Arguments
Name Description
cid - ID! public_id of the community to check membership for.
id - ID public_id of the user to check. Defaults to the authenticated user.

Example

Query
query communityMemberCheck(
  $cid: ID!,
  $id: ID
) {
  communityMemberCheck(
    cid: $cid,
    id: $id
  ) {
    success
  }
}
Variables
{"cid": 4, "id": 4}
Response
{"data": {"communityMemberCheck": {"success": false}}}

communityMembers

Description

Returns paginated members of a community. Authorization: For a team-scoped room (teamId present), requires an actual CommunityMember record — seated team membership alone is not enough. Admins bypass. teamId-nil (public/free) communities are unaffected. See Communities § Room Access Boundary.

Response

Returns [CommunityMember!]

Arguments
Name Description
communityId - ID! public_id of the community.
limit - Int Number of members to return. Defaults to 50.
offset - Int Number of members to skip. Defaults to 0.

Example

Query
query communityMembers(
  $communityId: ID!,
  $limit: Int,
  $offset: Int
) {
  communityMembers(
    communityId: $communityId,
    limit: $limit,
    offset: $offset
  ) {
    createdAtTime
    goalsCompleted
    helpfulCount
    id
    joinedDate
    points
    postsCount
    rank
    role
    updatedAtTime
    user {
      ...UserFragment
    }
    userPublicId
  }
}
Variables
{"communityId": 4, "limit": 987, "offset": 987}
Response
{
  "data": {
    "communityMembers": [
      {
        "createdAtTime": "xyz789",
        "goalsCompleted": 123,
        "helpfulCount": 987,
        "id": "4",
        "joinedDate": "abc123",
        "points": 123,
        "postsCount": 987,
        "rank": 987,
        "role": "abc123",
        "updatedAtTime": "abc123",
        "user": User,
        "userPublicId": "abc123"
      }
    ]
  }
}

communitySuggestions

Description

Returns communities suggested for a user based on their goals and interests.

Response

Returns [CommunitySuggestion!]

Arguments
Name Description
userId - ID public_id of the user to generate suggestions for. Defaults to the current user.

Example

Query
query communitySuggestions($userId: ID) {
  communitySuggestions(userId: $userId) {
    content
    goalCategory {
      ...GoalCategoryFragment
    }
    goalKind {
      ...GoalTypeFragment
    }
    id
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "communitySuggestions": [
      {
        "content": "xyz789",
        "goalCategory": GoalCategory,
        "goalKind": GoalType,
        "id": 4
      }
    ]
  }
}

connectedApps

Description

Returns the current user's Connected Apps state: available providers plus their own connections and mappings. Requires authentication.

Response

Returns a ConnectedApps!

Example

Query
query connectedApps {
  connectedApps {
    connections {
      ...IntegrationConnectionFragment
    }
    habitLinkSummary {
      ...HabitLinkSummaryFragment
    }
    mappings {
      ...HabitIntegrationMappingFragment
    }
    providers {
      ...IntegrationProviderFragment
    }
    suggestions {
      ...IntegrationSuggestionFragment
    }
    weeklyAutoCheckIns {
      ...AutoCheckInWeekFragment
    }
  }
}
Response
{
  "data": {
    "connectedApps": {
      "connections": [IntegrationConnection],
      "habitLinkSummary": HabitLinkSummary,
      "mappings": [HabitIntegrationMapping],
      "providers": [IntegrationProvider],
      "suggestions": [IntegrationSuggestion],
      "weeklyAutoCheckIns": AutoCheckInWeek
    }
  }
}

contentReports

Description

Admin only. Pending user-submitted content reports, newest first.

Response

Returns [ContentReport!]!

Example

Query
query contentReports {
  contentReports {
    contentPreview
    createdAt
    details
    id
    reason
    reportableType
    reporterName
    status
  }
}
Response
{
  "data": {
    "contentReports": [
      {
        "contentPreview": "abc123",
        "createdAt": "abc123",
        "details": "xyz789",
        "id": "xyz789",
        "reason": "xyz789",
        "reportableType": "abc123",
        "reporterName": "xyz789",
        "status": "abc123"
      }
    ]
  }
}

criticalPathReminderPreferences

Description

Returns the daily reminder preferences for the authenticated user.

Example

Query
query criticalPathReminderPreferences {
  criticalPathReminderPreferences {
    enabled
    timeOfDay
    timezone
    timezoneNeedsConfirmation
  }
}
Response
{
  "data": {
    "criticalPathReminderPreferences": {
      "enabled": true,
      "timeOfDay": "xyz789",
      "timezone": "abc123",
      "timezoneNeedsConfirmation": false
    }
  }
}

criticalPathStimXpStatus

Description

Returns the authenticated user's Stim XP totals, streak, theme, and theme catalog.

Response

Returns a StimXpStatus!

Example

Query
query criticalPathStimXpStatus {
  criticalPathStimXpStatus {
    activeTheme
    currentStimStreak
    longestStimStreak
    themesCatalog {
      ...CriticalPathThemeFragment
    }
    totalStimXp
    unlockedThemes
  }
}
Response
{
  "data": {
    "criticalPathStimXpStatus": {
      "activeTheme": "xyz789",
      "currentStimStreak": 123,
      "longestStimStreak": 987,
      "themesCatalog": [CriticalPathTheme],
      "totalStimXp": 987,
      "unlockedThemes": ["abc123"]
    }
  }
}

criticalPathToday

Description

Returns today's Critical Path puzzle status for the authenticated user.

Response

Returns a CriticalPathPlayStatus!

Example

Query
query criticalPathToday {
  criticalPathToday {
    completed
    elapsedSeconds
    percentile
    puzzleDate
    puzzleSeed
    typicalSeconds
  }
}
Response
{
  "data": {
    "criticalPathToday": {
      "completed": true,
      "elapsedSeconds": 987,
      "percentile": 123,
      "puzzleDate": ISO8601Date,
      "puzzleSeed": 123,
      "typicalSeconds": 987
    }
  }
}

curatableCommunities

Description

Returns discoverable communities with their editorial fields, ordered by editorial_slot, editorial_position, then name. Admin only.

Response

Returns [Community!]

Example

Query
query curatableCommunities {
  curatableCommunities {
    activeChallenge {
      ...CommunityChallengeFragment
    }
    activeMembers
    archiveDaysLeft
    archivedAt
    badges {
      ...CommunityBadgesFragment
    }
    category
    checkInsPerWeek
    coverImage
    createdAt
    createdAtTime
    demo
    description
    editorialPosition
    editorialSlot
    feedItems {
      ...CommunityFeedItemFragment
    }
    goalCategory {
      ...GoalCategoryFragment
    }
    goals {
      ...GoalFragment
    }
    growthRate
    guidelines
    healthScore
    icon
    id
    imageUrl
    isDefault
    isDefaultForTeam
    isFeatured
    isFounding
    isGated
    isMember
    isVerified
    joinPolicy
    leadMembershipId
    leadName
    memberCount
    members {
      ...CommunityMemberFragment
    }
    membersToDiscoverable
    name
    pastChallenges {
      ...CommunityChallengeFragment
    }
    privacy
    private
    publicId
    reason {
      ...CommunityReasonFragment
    }
    teamId
    teamName
    totalGoals
    upcomingChallenges {
      ...CommunityChallengeFragment
    }
    upcomingEvents {
      ...CommunityEventFragment
    }
    updatedAtTime
    userProgressPercent
    viewerCanCreateEvents
    viewerDigest {
      ...CommunityViewerDigestFragment
    }
  }
}
Response
{
  "data": {
    "curatableCommunities": [
      {
        "activeChallenge": CommunityChallenge,
        "activeMembers": 987,
        "archiveDaysLeft": 123,
        "archivedAt": ISO8601DateTime,
        "badges": CommunityBadges,
        "category": "xyz789",
        "checkInsPerWeek": 123,
        "coverImage": "abc123",
        "createdAt": ISO8601DateTime,
        "createdAtTime": "xyz789",
        "demo": false,
        "description": "abc123",
        "editorialPosition": 123,
        "editorialSlot": "xyz789",
        "feedItems": [CommunityFeedItem],
        "goalCategory": GoalCategory,
        "goals": [Goal],
        "growthRate": 123.45,
        "guidelines": "xyz789",
        "healthScore": 123,
        "icon": "xyz789",
        "id": "4",
        "imageUrl": "xyz789",
        "isDefault": true,
        "isDefaultForTeam": false,
        "isFeatured": true,
        "isFounding": true,
        "isGated": false,
        "isMember": true,
        "isVerified": true,
        "joinPolicy": "xyz789",
        "leadMembershipId": 4,
        "leadName": "abc123",
        "memberCount": 123,
        "members": [CommunityMember],
        "membersToDiscoverable": 987,
        "name": "xyz789",
        "pastChallenges": [CommunityChallenge],
        "privacy": "abc123",
        "private": false,
        "publicId": 4,
        "reason": CommunityReason,
        "teamId": "4",
        "teamName": "abc123",
        "totalGoals": 987,
        "upcomingChallenges": [CommunityChallenge],
        "upcomingEvents": [CommunityEvent],
        "updatedAtTime": "abc123",
        "userProgressPercent": 987.65,
        "viewerCanCreateEvents": true,
        "viewerDigest": CommunityViewerDigest
      }
    ]
  }
}

dataImportStatus

Description

Reads commit progress/result for a DataImport owned by the authenticated user.

Response

Returns a DataImport

Arguments
Name Description
id - ID! public_id of the DataImport to read.

Example

Query
query dataImportStatus($id: ID!) {
  dataImportStatus(id: $id) {
    collisions {
      ...DataImportCollisionFragment
    }
    commitStage
    committedAt
    completionCount
    createdAt
    createdCount
    currentStep
    currentStreak
    failedCount
    goalCount
    id
    rowErrors {
      ...DataImportRowIssueFragment
    }
    rowWarnings {
      ...DataImportRowIssueFragment
    }
    skippedCount
    source
    status
    totalSteps
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "dataImportStatus": {
      "collisions": [DataImportCollision],
      "commitStage": "xyz789",
      "committedAt": ISO8601DateTime,
      "completionCount": 987,
      "createdAt": ISO8601DateTime,
      "createdCount": 123,
      "currentStep": 987,
      "currentStreak": 123,
      "failedCount": 123,
      "goalCount": 123,
      "id": "4",
      "rowErrors": [DataImportRowIssue],
      "rowWarnings": [DataImportRowIssue],
      "skippedCount": 123,
      "source": "abc123",
      "status": "abc123",
      "totalSteps": 987
    }
  }
}

demoDataRunStatus

Description

Polls Rails.cache for the progress of an in-flight demo-data job.

Response

Returns a DemoDataRunStatus!

Arguments
Name Description
jobId - ID!

Example

Query
query demoDataRunStatus($jobId: ID!) {
  demoDataRunStatus(jobId: $jobId) {
    currentStep
    error
    finishedAt
    scope
    startedAt
    status
    totalSteps
  }
}
Variables
{"jobId": "4"}
Response
{
  "data": {
    "demoDataRunStatus": {
      "currentStep": 123,
      "error": "abc123",
      "finishedAt": ISO8601DateTime,
      "scope": "abc123",
      "startedAt": ISO8601DateTime,
      "status": "abc123",
      "totalSteps": 123
    }
  }
}

demoScopePreview

Description

Live counts of demo-tagged records across all 12 demo-bearing tables.

Response

Returns a DemoScopePreview!

Example

Query
query demoScopePreview {
  demoScopePreview {
    aiArtifacts
    aiEmployees
    aiRuns
    communities
    feedItems
    feedbackComments
    feedbackPosts
    feedbackVotes
    goalEvents
    goals
    totalRecords
    userAllies
    users
  }
}
Response
{
  "data": {
    "demoScopePreview": {
      "aiArtifacts": 123,
      "aiEmployees": 123,
      "aiRuns": 123,
      "communities": 987,
      "feedItems": 123,
      "feedbackComments": 123,
      "feedbackPosts": 987,
      "feedbackVotes": 987,
      "goalEvents": 987,
      "goals": 987,
      "totalRecords": 123,
      "userAllies": 987,
      "users": 987
    }
  }
}

editorialCommunities

Description

Returns up to 8 communities admin-assigned to the given editorial slot, ordered by editorial_position then editorial_updated_at. Unknown slots return [].

Response

Returns [Community!]

Arguments
Name Description
slot - String! Editorial slot to fetch (e.g. "active_now", "just_started", "most_members").

Example

Query
query editorialCommunities($slot: String!) {
  editorialCommunities(slot: $slot) {
    activeChallenge {
      ...CommunityChallengeFragment
    }
    activeMembers
    archiveDaysLeft
    archivedAt
    badges {
      ...CommunityBadgesFragment
    }
    category
    checkInsPerWeek
    coverImage
    createdAt
    createdAtTime
    demo
    description
    editorialPosition
    editorialSlot
    feedItems {
      ...CommunityFeedItemFragment
    }
    goalCategory {
      ...GoalCategoryFragment
    }
    goals {
      ...GoalFragment
    }
    growthRate
    guidelines
    healthScore
    icon
    id
    imageUrl
    isDefault
    isDefaultForTeam
    isFeatured
    isFounding
    isGated
    isMember
    isVerified
    joinPolicy
    leadMembershipId
    leadName
    memberCount
    members {
      ...CommunityMemberFragment
    }
    membersToDiscoverable
    name
    pastChallenges {
      ...CommunityChallengeFragment
    }
    privacy
    private
    publicId
    reason {
      ...CommunityReasonFragment
    }
    teamId
    teamName
    totalGoals
    upcomingChallenges {
      ...CommunityChallengeFragment
    }
    upcomingEvents {
      ...CommunityEventFragment
    }
    updatedAtTime
    userProgressPercent
    viewerCanCreateEvents
    viewerDigest {
      ...CommunityViewerDigestFragment
    }
  }
}
Variables
{"slot": "abc123"}
Response
{
  "data": {
    "editorialCommunities": [
      {
        "activeChallenge": CommunityChallenge,
        "activeMembers": 987,
        "archiveDaysLeft": 987,
        "archivedAt": ISO8601DateTime,
        "badges": CommunityBadges,
        "category": "abc123",
        "checkInsPerWeek": 123,
        "coverImage": "abc123",
        "createdAt": ISO8601DateTime,
        "createdAtTime": "xyz789",
        "demo": true,
        "description": "xyz789",
        "editorialPosition": 123,
        "editorialSlot": "abc123",
        "feedItems": [CommunityFeedItem],
        "goalCategory": GoalCategory,
        "goals": [Goal],
        "growthRate": 123.45,
        "guidelines": "abc123",
        "healthScore": 987,
        "icon": "xyz789",
        "id": "4",
        "imageUrl": "xyz789",
        "isDefault": true,
        "isDefaultForTeam": false,
        "isFeatured": true,
        "isFounding": false,
        "isGated": false,
        "isMember": false,
        "isVerified": true,
        "joinPolicy": "abc123",
        "leadMembershipId": "4",
        "leadName": "xyz789",
        "memberCount": 987,
        "members": [CommunityMember],
        "membersToDiscoverable": 987,
        "name": "xyz789",
        "pastChallenges": [CommunityChallenge],
        "privacy": "xyz789",
        "private": true,
        "publicId": "4",
        "reason": CommunityReason,
        "teamId": 4,
        "teamName": "xyz789",
        "totalGoals": 987,
        "upcomingChallenges": [CommunityChallenge],
        "upcomingEvents": [CommunityEvent],
        "updatedAtTime": "abc123",
        "userProgressPercent": 123.45,
        "viewerCanCreateEvents": false,
        "viewerDigest": CommunityViewerDigest
      }
    ]
  }
}

enneagramAssessment

Description

Returns the latest non-deleted Enneagram assessment for a user. Auth: own user or admin.

Response

Returns an EnneagramAssessment

Arguments
Name Description
userId - ID! public_id of the user whose latest assessment to retrieve.

Example

Query
query enneagramAssessment($userId: ID!) {
  enneagramAssessment(userId: $userId) {
    completedAt
    dominantType
    id
    scores
    tritype
    wing
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "enneagramAssessment": {
      "completedAt": ISO8601DateTime,
      "dominantType": 123,
      "id": "4",
      "scores": {},
      "tritype": "abc123",
      "wing": 987
    }
  }
}

enneagramAssessmentHistory

Description

Returns all Enneagram assessments for a user, newest first. Auth: own user or admin.

Response

Returns [EnneagramAssessment!]!

Arguments
Name Description
userId - ID! public_id of the user whose assessment history to retrieve.

Example

Query
query enneagramAssessmentHistory($userId: ID!) {
  enneagramAssessmentHistory(userId: $userId) {
    completedAt
    dominantType
    id
    scores
    tritype
    wing
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "enneagramAssessmentHistory": [
      {
        "completedAt": ISO8601DateTime,
        "dominantType": 987,
        "id": "4",
        "scores": {},
        "tritype": "abc123",
        "wing": 123
      }
    ]
  }
}

feedbackPost

Description

Returns a single feedback post by public ID.

Response

Returns a FeedbackPost

Arguments
Name Description
id - ID! Public ID of the feedback post.

Example

Query
query feedbackPost($id: ID!) {
  feedbackPost(id: $id) {
    category
    commentCount
    comments {
      ...FeedbackCommentFragment
    }
    createdAt
    description
    id
    shippedAt
    status
    tags {
      ...FeedbackTagFragment
    }
    title
    user {
      ...UserFragment
    }
    voteCount
    votedByCurrentUser
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "feedbackPost": {
      "category": "abc123",
      "commentCount": 987,
      "comments": [FeedbackComment],
      "createdAt": ISO8601DateTime,
      "description": "xyz789",
      "id": 4,
      "shippedAt": ISO8601DateTime,
      "status": "xyz789",
      "tags": [FeedbackTag],
      "title": "abc123",
      "user": User,
      "voteCount": 987,
      "votedByCurrentUser": true
    }
  }
}

feedbackPosts

Description

Returns feedback posts, filterable by category, status, and search.

Response

Returns [FeedbackPost!]

Arguments
Name Description
category - String Filter by category (feature, improvement, bug, other).
filter - String Filter view: my_posts (current user posts), my_votes (posts user voted on).
search - String Search titles and descriptions (case-insensitive).
sort - String Sort order: votes (default), newest.
status - String Filter by status (open, planned, in_progress, completed, declined).
tags - [String!] Filter by tag slugs (any-of). Posts carrying any of the given tags are returned.

Example

Query
query feedbackPosts(
  $category: String,
  $filter: String,
  $search: String,
  $sort: String,
  $status: String,
  $tags: [String!]
) {
  feedbackPosts(
    category: $category,
    filter: $filter,
    search: $search,
    sort: $sort,
    status: $status,
    tags: $tags
  ) {
    category
    commentCount
    comments {
      ...FeedbackCommentFragment
    }
    createdAt
    description
    id
    shippedAt
    status
    tags {
      ...FeedbackTagFragment
    }
    title
    user {
      ...UserFragment
    }
    voteCount
    votedByCurrentUser
  }
}
Variables
{
  "category": "xyz789",
  "filter": "abc123",
  "search": "xyz789",
  "sort": "xyz789",
  "status": "abc123",
  "tags": ["xyz789"]
}
Response
{
  "data": {
    "feedbackPosts": [
      {
        "category": "abc123",
        "commentCount": 987,
        "comments": [FeedbackComment],
        "createdAt": ISO8601DateTime,
        "description": "abc123",
        "id": "4",
        "shippedAt": ISO8601DateTime,
        "status": "abc123",
        "tags": [FeedbackTag],
        "title": "xyz789",
        "user": User,
        "voteCount": 987,
        "votedByCurrentUser": true
      }
    ]
  }
}

feedbackStats

Description

Returns feedback board statistics for admin dashboard. Admin only.

Response

Returns a FeedbackStats

Example

Query
query feedbackStats {
  feedbackStats {
    categoryBreakdown {
      ...FeedbackCategoryBreakdownFragment
    }
    completedPosts
    declinedPosts
    inProgressPosts
    openPosts
    plannedPosts
    postsThisWeek
    topPosts {
      ...FeedbackPostFragment
    }
    totalComments
    totalPosts
    totalVotes
  }
}
Response
{
  "data": {
    "feedbackStats": {
      "categoryBreakdown": [FeedbackCategoryBreakdown],
      "completedPosts": 987,
      "declinedPosts": 123,
      "inProgressPosts": 123,
      "openPosts": 987,
      "plannedPosts": 123,
      "postsThisWeek": 987,
      "topPosts": [FeedbackPost],
      "totalComments": 987,
      "totalPosts": 987,
      "totalVotes": 123
    }
  }
}

feedbackTags

Description

Returns feedback tags, non-archived by default. Admin only.

Response

Returns [FeedbackTag!]

Arguments
Name Description
includeArchived - Boolean Include archived tags (for the admin UI). Default = false

Example

Query
query feedbackTags($includeArchived: Boolean) {
  feedbackTags(includeArchived: $includeArchived) {
    archived
    createdAt
    description
    id
    name
    position
    postsCount
    slug
  }
}
Variables
{"includeArchived": false}
Response
{
  "data": {
    "feedbackTags": [
      {
        "archived": true,
        "createdAt": ISO8601DateTime,
        "description": "abc123",
        "id": 4,
        "name": "xyz789",
        "position": 123,
        "postsCount": 123,
        "slug": "xyz789"
      }
    ]
  }
}

feedbackWeeklySummary

Description

Coach-analyzed themed summary of the past week of feedback. Admin only. Null when there is nothing to summarize.

Response

Returns a FeedbackWeeklySummary

Example

Query
query feedbackWeeklySummary {
  feedbackWeeklySummary {
    emergingRequests
    generatedAt
    themes {
      ...FeedbackThemeFragment
    }
  }
}
Response
{
  "data": {
    "feedbackWeeklySummary": {
      "emergingRequests": ["abc123"],
      "generatedAt": ISO8601DateTime,
      "themes": [FeedbackTheme]
    }
  }
}

findUserForInvite

Description

Phase 75. Looks up a user by username or email for ally invite. Exactly one arg required. Auth-required. Rate-limited (10/min). Returns nil for not-found or soft-deleted users (no enumeration).

Response

Returns a User

Arguments
Name Description
email - String Email address to search for. Mutually exclusive with username.
username - String Username to search for. Mutually exclusive with email.

Example

Query
query findUserForInvite(
  $email: String,
  $username: String
) {
  findUserForInvite(
    email: $email,
    username: $username
  ) {
    achievementStats {
      ...AchievementStatsFragment
    }
    actions {
      ...UserActionFragment
    }
    admin
    adminRoles
    badgeActions {
      ...UserActionFragment
    }
    celebrationPreferences {
      ...CelebrationPreferencesFragment
    }
    charterMarkerHidden
    charterMemberSince
    charterNotesEnabled
    coachingPreferences {
      ...CoachingPreferencesFragment
    }
    colorTheme
    completedCommunityChallenges {
      ...ChallengeParticipantFragment
    }
    completedSeasonalEvents {
      ...SeasonalEventParticipantFragment
    }
    createdAtTime
    currentInsights {
      ...InsightPackFragment
    }
    dashboardPreferences {
      ...DashboardPreferencesFragment
    }
    dayClosedToday
    daysShownUp
    daysSinceLastActive
    demo
    details {
      ...UserDetailFragment
    }
    email
    emailVerified
    featureTourStatus
    feedItems {
      ...UserFeedItemFragment
    }
    firstName
    goItAlone
    goalDayContext {
      ...GoalDayContextFragment
    }
    goalDayLog {
      ...GoalDayLogEntryFragment
    }
    goalDaySummaries {
      ...GoalDaySummaryFragment
    }
    goalMotivationProfile {
      ...GoalMotivationProfileFragment
    }
    goals {
      ...GoalFragment
    }
    graceDays
    hasAlly
    hasCreatedFromTemplate
    hasDigestEnabled
    isSupporter
    lastDigestSentAt
    lastName
    latestEnneagramAssessment {
      ...EnneagramAssessmentFragment
    }
    level
    longestStreak
    moodGoalInsight {
      ...InsightPackFragment
    }
    nextLevelThreshold
    nextOnTheShelfBadge {
      ...NextBadgeFragment
    }
    notifications {
      ...UserNotificationFragment
    }
    onboardingStatus {
      ...OnboardingStatusFragment
    }
    paceSuggestion {
      ...PaceSuggestionFragment
    }
    photo {
      ...UserPhotoFragment
    }
    practiceInviteDismissedAt
    privateMode
    progressToNextLevel
    publicId
    recentlyUnlockedBadges {
      ...RecentlyUnlockedBadgeFragment
    }
    requiredCheckinsCompleteToday
    reverseNudge {
      ...ReverseNudgeFragment
    }
    showcasedAchievements
    signInDates
    signupAgeDays
    stats {
      ...UserStatsFragment
    }
    streak
    streakJourney {
      ...StreakJourneyFragment
    }
    streakRecountNotePending
    streakRepairOffer {
      ...StreakRepairOfferFragment
    }
    streakRescueDays {
      ...StreakRescueDayFragment
    }
    supporterCancelAtPeriodEnd
    supporterMoments {
      ...SupporterMomentsFragment
    }
    supporterTier
    supporterUntil
    timeToFirstGoalSeconds
    todaysMood
    unlockedAchievementKeys
    updatedAtTime
    username
    welcomeBackOffer {
      ...WelcomeBackOfferFragment
    }
    xp
  }
}
Variables
{
  "email": "xyz789",
  "username": "abc123"
}
Response
{
  "data": {
    "findUserForInvite": {
      "achievementStats": AchievementStats,
      "actions": [UserAction],
      "admin": true,
      "adminRoles": ["abc123"],
      "badgeActions": [UserAction],
      "celebrationPreferences": CelebrationPreferences,
      "charterMarkerHidden": true,
      "charterMemberSince": ISO8601DateTime,
      "charterNotesEnabled": true,
      "coachingPreferences": CoachingPreferences,
      "colorTheme": "xyz789",
      "completedCommunityChallenges": [
        ChallengeParticipant
      ],
      "completedSeasonalEvents": [
        SeasonalEventParticipant
      ],
      "createdAtTime": "xyz789",
      "currentInsights": [InsightPack],
      "dashboardPreferences": DashboardPreferences,
      "dayClosedToday": true,
      "daysShownUp": 123,
      "daysSinceLastActive": 123,
      "demo": true,
      "details": UserDetail,
      "email": "abc123",
      "emailVerified": true,
      "featureTourStatus": {},
      "feedItems": [UserFeedItem],
      "firstName": "abc123",
      "goItAlone": true,
      "goalDayContext": GoalDayContext,
      "goalDayLog": [GoalDayLogEntry],
      "goalDaySummaries": [GoalDaySummary],
      "goalMotivationProfile": GoalMotivationProfile,
      "goals": [Goal],
      "graceDays": ["abc123"],
      "hasAlly": false,
      "hasCreatedFromTemplate": false,
      "hasDigestEnabled": false,
      "isSupporter": true,
      "lastDigestSentAt": "xyz789",
      "lastName": "abc123",
      "latestEnneagramAssessment": EnneagramAssessment,
      "level": 987,
      "longestStreak": 123,
      "moodGoalInsight": InsightPack,
      "nextLevelThreshold": 987,
      "nextOnTheShelfBadge": NextBadge,
      "notifications": [UserNotification],
      "onboardingStatus": OnboardingStatus,
      "paceSuggestion": PaceSuggestion,
      "photo": UserPhoto,
      "practiceInviteDismissedAt": "xyz789",
      "privateMode": false,
      "progressToNextLevel": 123.45,
      "publicId": 4,
      "recentlyUnlockedBadges": [RecentlyUnlockedBadge],
      "requiredCheckinsCompleteToday": false,
      "reverseNudge": ReverseNudge,
      "showcasedAchievements": ["xyz789"],
      "signInDates": ["abc123"],
      "signupAgeDays": 123,
      "stats": UserStats,
      "streak": 123,
      "streakJourney": StreakJourney,
      "streakRecountNotePending": false,
      "streakRepairOffer": StreakRepairOffer,
      "streakRescueDays": [StreakRescueDay],
      "supporterCancelAtPeriodEnd": true,
      "supporterMoments": SupporterMoments,
      "supporterTier": "xyz789",
      "supporterUntil": ISO8601DateTime,
      "timeToFirstGoalSeconds": 987,
      "todaysMood": "xyz789",
      "unlockedAchievementKeys": ["abc123"],
      "updatedAtTime": "xyz789",
      "username": "xyz789",
      "welcomeBackOffer": WelcomeBackOffer,
      "xp": 123
    }
  }
}

formingCommunities

Description

Returns up to 12 newly forming communities (0-4 members), newest first, excluding communities the caller admins. Requires authentication.

Response

Returns [Community!]

Example

Query
query formingCommunities {
  formingCommunities {
    activeChallenge {
      ...CommunityChallengeFragment
    }
    activeMembers
    archiveDaysLeft
    archivedAt
    badges {
      ...CommunityBadgesFragment
    }
    category
    checkInsPerWeek
    coverImage
    createdAt
    createdAtTime
    demo
    description
    editorialPosition
    editorialSlot
    feedItems {
      ...CommunityFeedItemFragment
    }
    goalCategory {
      ...GoalCategoryFragment
    }
    goals {
      ...GoalFragment
    }
    growthRate
    guidelines
    healthScore
    icon
    id
    imageUrl
    isDefault
    isDefaultForTeam
    isFeatured
    isFounding
    isGated
    isMember
    isVerified
    joinPolicy
    leadMembershipId
    leadName
    memberCount
    members {
      ...CommunityMemberFragment
    }
    membersToDiscoverable
    name
    pastChallenges {
      ...CommunityChallengeFragment
    }
    privacy
    private
    publicId
    reason {
      ...CommunityReasonFragment
    }
    teamId
    teamName
    totalGoals
    upcomingChallenges {
      ...CommunityChallengeFragment
    }
    upcomingEvents {
      ...CommunityEventFragment
    }
    updatedAtTime
    userProgressPercent
    viewerCanCreateEvents
    viewerDigest {
      ...CommunityViewerDigestFragment
    }
  }
}
Response
{
  "data": {
    "formingCommunities": [
      {
        "activeChallenge": CommunityChallenge,
        "activeMembers": 123,
        "archiveDaysLeft": 123,
        "archivedAt": ISO8601DateTime,
        "badges": CommunityBadges,
        "category": "abc123",
        "checkInsPerWeek": 123,
        "coverImage": "xyz789",
        "createdAt": ISO8601DateTime,
        "createdAtTime": "xyz789",
        "demo": true,
        "description": "abc123",
        "editorialPosition": 987,
        "editorialSlot": "xyz789",
        "feedItems": [CommunityFeedItem],
        "goalCategory": GoalCategory,
        "goals": [Goal],
        "growthRate": 987.65,
        "guidelines": "abc123",
        "healthScore": 987,
        "icon": "xyz789",
        "id": "4",
        "imageUrl": "xyz789",
        "isDefault": false,
        "isDefaultForTeam": true,
        "isFeatured": true,
        "isFounding": true,
        "isGated": false,
        "isMember": true,
        "isVerified": false,
        "joinPolicy": "xyz789",
        "leadMembershipId": "4",
        "leadName": "xyz789",
        "memberCount": 987,
        "members": [CommunityMember],
        "membersToDiscoverable": 987,
        "name": "xyz789",
        "pastChallenges": [CommunityChallenge],
        "privacy": "abc123",
        "private": false,
        "publicId": 4,
        "reason": CommunityReason,
        "teamId": "4",
        "teamName": "xyz789",
        "totalGoals": 987,
        "upcomingChallenges": [CommunityChallenge],
        "upcomingEvents": [CommunityEvent],
        "updatedAtTime": "xyz789",
        "userProgressPercent": 123.45,
        "viewerCanCreateEvents": true,
        "viewerDigest": CommunityViewerDigest
      }
    ]
  }
}

funnelStats

Description

Onboarding funnel aggregates and TTFG percentiles. Admin or marketing role.

Response

Returns an OnboardingFunnel

Arguments
Name Description
periodSeconds - Int Window in seconds (default 30 days = 2,592,000).
variantId - String Filter to a specific onboarding variant cohort (e.g. control, variant_a).

Example

Query
query funnelStats(
  $periodSeconds: Int,
  $variantId: String
) {
  funnelStats(
    periodSeconds: $periodSeconds,
    variantId: $variantId
  ) {
    firstGoal
    signedIn
    ttfgP50Seconds
    ttfgP90Seconds
    variantId
    wizardCompleted
    wizardStarted
  }
}
Variables
{
  "periodSeconds": 987,
  "variantId": "xyz789"
}
Response
{
  "data": {
    "funnelStats": {
      "firstGoal": 987,
      "signedIn": 987,
      "ttfgP50Seconds": 987,
      "ttfgP90Seconds": 123,
      "variantId": "xyz789",
      "wizardCompleted": 123,
      "wizardStarted": 987
    }
  }
}

gdprRequest

Description

Fetch a GDPR request by public_id. super_admin or support only.

Response

Returns a GdprRequest

Arguments
Name Description
publicId - String! public_id of the GDPR request.

Example

Query
query gdprRequest($publicId: String!) {
  gdprRequest(publicId: $publicId) {
    cascadePreview {
      ...CascadePreviewFragment
    }
    dueBy
    exportExpiresAt
    exportFileUrl
    fulfilledAt
    fulfilledBy {
      ...UserFragment
    }
    notes
    publicId
    receivedAt
    requestType
    requestorEmail
    status
  }
}
Variables
{"publicId": "abc123"}
Response
{
  "data": {
    "gdprRequest": {
      "cascadePreview": CascadePreview,
      "dueBy": ISO8601DateTime,
      "exportExpiresAt": ISO8601DateTime,
      "exportFileUrl": "abc123",
      "fulfilledAt": ISO8601DateTime,
      "fulfilledBy": User,
      "notes": "xyz789",
      "publicId": "abc123",
      "receivedAt": ISO8601DateTime,
      "requestType": "xyz789",
      "requestorEmail": "xyz789",
      "status": "xyz789"
    }
  }
}

gdprRequests

Description

GDPR request queue. super_admin or support only.

Response

Returns a GdprRequestConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
requestType - String Filter by request type.
status - String Filter by status.

Example

Query
query gdprRequests(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $requestType: String,
  $status: String
) {
  gdprRequests(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    requestType: $requestType,
    status: $status
  ) {
    edges {
      ...GdprRequestEdgeFragment
    }
    nodes {
      ...GdprRequestFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987,
  "requestType": "xyz789",
  "status": "abc123"
}
Response
{
  "data": {
    "gdprRequests": {
      "edges": [GdprRequestEdge],
      "nodes": [GdprRequest],
      "pageInfo": PageInfo
    }
  }
}

goal

Description

Fetches a private goal owned by the authenticated user.

Response

Returns a Goal

Arguments
Name Description
id - ID! public_id of the goal to retrieve.

Example

Query
query goal($id: ID!) {
  goal(id: $id) {
    allEvents {
      ...GoalEventFragment
    }
    appLink
    averageCheckInTime
    calendarMonth {
      ...GoalCalendarMonthFragment
    }
    category {
      ...GoalCategoryFragment
    }
    challenge {
      ...GoalChallengeFragment
    }
    chapters {
      ...GoalChapterFragment
    }
    checkedInToday
    collectiveGoalContribution {
      ...GoalCollectiveContributionFragment
    }
    comments {
      ...GoalEventCommentFragment
    }
    completed
    completedAtTime
    completionRate
    completionReflection
    content
    continuesGoal {
      ...GoalFragment
    }
    createdAtTime
    currentAmount
    dayOfWeekDistribution
    daysToUpdate
    demo
    dueToday
    durationMinutes
    encouragedBy {
      ...EncouragedByFragment
    }
    encouragements {
      ...GoalEventEncouragementFragment
    }
    events {
      ...GoalEventFragment
    }
    followersCount
    fromTemplate {
      ...GoalTemplateFragment
    }
    fromTemplateName
    habitCompletions {
      ...HabitCompletionFragment
    }
    habitStreak
    habitStreakUnit
    identityPrompt
    imageUrl
    journeyRecap {
      ...JourneyRecapFragment
    }
    kind {
      ...GoalTypeFragment
    }
    lastCheckedInDate
    lifeArea
    lockVersion
    longestHabitStreak
    milestones {
      ...GoalFragment
    }
    name
    nonAllyFollowersCount
    parentGoalId
    pastAttemptContext
    position
    practiceWeek {
      ...PracticeWeekFragment
    }
    practices {
      ...GoalFragment
    }
    preBreakHabitStreak
    private
    publicId
    quickUpdatePrompts
    recurrenceDays
    recurrenceInterval
    recurrenceType
    sharedWithPartner
    status
    streakFreezesAvailable
    streakFreezesUsed
    streakRepairEligibleUntil
    streakRepairedCount
    successorGoal {
      ...GoalFragment
    }
    successorOffer {
      ...SuccessorOfferFragment
    }
    supportsGoal {
      ...GoalFragment
    }
    targetAmount
    targetDateTime
    totalCheckIns
    unit
    updatedAtTime
    user {
      ...UserFragment
    }
    viewerCheeredToday
    visibility
    weeklyTarget
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "goal": {
      "allEvents": [GoalEvent],
      "appLink": "abc123",
      "averageCheckInTime": 123.45,
      "calendarMonth": GoalCalendarMonth,
      "category": GoalCategory,
      "challenge": GoalChallenge,
      "chapters": [GoalChapter],
      "checkedInToday": false,
      "collectiveGoalContribution": GoalCollectiveContribution,
      "comments": [GoalEventComment],
      "completed": false,
      "completedAtTime": "abc123",
      "completionRate": 987.65,
      "completionReflection": "abc123",
      "content": "xyz789",
      "continuesGoal": Goal,
      "createdAtTime": "xyz789",
      "currentAmount": 987.65,
      "dayOfWeekDistribution": [987],
      "daysToUpdate": 987,
      "demo": true,
      "dueToday": true,
      "durationMinutes": 123,
      "encouragedBy": EncouragedBy,
      "encouragements": [GoalEventEncouragement],
      "events": [GoalEvent],
      "followersCount": 123,
      "fromTemplate": GoalTemplate,
      "fromTemplateName": "xyz789",
      "habitCompletions": [HabitCompletion],
      "habitStreak": 123,
      "habitStreakUnit": "DAY",
      "identityPrompt": "abc123",
      "imageUrl": "abc123",
      "journeyRecap": JourneyRecap,
      "kind": GoalType,
      "lastCheckedInDate": "abc123",
      "lifeArea": "xyz789",
      "lockVersion": 987,
      "longestHabitStreak": 123,
      "milestones": [Goal],
      "name": "abc123",
      "nonAllyFollowersCount": 123,
      "parentGoalId": "xyz789",
      "pastAttemptContext": "xyz789",
      "position": 123,
      "practiceWeek": PracticeWeek,
      "practices": [Goal],
      "preBreakHabitStreak": 987,
      "private": false,
      "publicId": 4,
      "quickUpdatePrompts": ["abc123"],
      "recurrenceDays": ["xyz789"],
      "recurrenceInterval": 987,
      "recurrenceType": "abc123",
      "sharedWithPartner": true,
      "status": "completed",
      "streakFreezesAvailable": 123,
      "streakFreezesUsed": 987,
      "streakRepairEligibleUntil": "abc123",
      "streakRepairedCount": 123,
      "successorGoal": Goal,
      "successorOffer": SuccessorOffer,
      "supportsGoal": Goal,
      "targetAmount": 987.65,
      "targetDateTime": "xyz789",
      "totalCheckIns": 987,
      "unit": "xyz789",
      "updatedAtTime": "xyz789",
      "user": User,
      "viewerCheeredToday": false,
      "visibility": "ALLIES",
      "weeklyTarget": 123
    }
  }
}

goalCategories

Description

Returns all available goal categories (fitness, learning, personal, etc.).

Response

Returns [GoalCategory!]

Example

Query
query goalCategories {
  goalCategories {
    id
    name
  }
}
Response
{
  "data": {
    "goalCategories": [
      {"id": 4, "name": "abc123"}
    ]
  }
}

goalEvent

Description

Fetches a single goal progress event by public_id.

Response

Returns a GoalEvent

Arguments
Name Description
id - ID! public_id of the goal event to retrieve.

Example

Query
query goalEvent($id: ID!) {
  goalEvent(id: $id) {
    amount
    clientTimestampTime
    comments {
      ...GoalEventCommentFragment
    }
    content
    createdAtTime
    encouragedBy {
      ...EncouragementFragment
    }
    encouragements {
      ...GoalEventEncouragementFragment
    }
    goal {
      ...GoalFragment
    }
    id
    loggedLate
    media {
      ...GoalMediaFragment
    }
    milestoneName
    mood
    publicId
    reactions {
      ...GoalEventReactionFragment
    }
    source
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "goalEvent": {
      "amount": 987.65,
      "clientTimestampTime": "abc123",
      "comments": [GoalEventComment],
      "content": "xyz789",
      "createdAtTime": "xyz789",
      "encouragedBy": [Encouragement],
      "encouragements": [GoalEventEncouragement],
      "goal": Goal,
      "id": "4",
      "loggedLate": false,
      "media": GoalMedia,
      "milestoneName": "xyz789",
      "mood": "abc123",
      "publicId": "4",
      "reactions": [GoalEventReaction],
      "source": "abc123"
    }
  }
}

goalIdeas

Description

Active (unpromoted, non-deleted) parked goal ideas for the authenticated user, entered order.

Response

Returns [GoalIdea!]!

Example

Query
query goalIdeas {
  goalIdeas {
    createdAt
    id
    text
  }
}
Response
{
  "data": {
    "goalIdeas": [
      {
        "createdAt": ISO8601DateTime,
        "id": "4",
        "text": "abc123"
      }
    ]
  }
}

goalKinds

Description

Returns all available goal types/kinds (habit, milestone, quantity, etc.).

Response

Returns [GoalType!]

Example

Query
query goalKinds {
  goalKinds {
    description
    displayNumber
    id
    name
  }
}
Response
{
  "data": {
    "goalKinds": [
      {
        "description": "xyz789",
        "displayNumber": 123,
        "id": 4,
        "name": "xyz789"
      }
    ]
  }
}

goalProgressData

Description

Returns progress visualization data for a goal.

Response

Returns a GoalProgressData

Arguments
Name Description
id - ID! public_id of the goal to get progress data for.
lookbackDays - Int Number of days to look back. Defaults to 90.
period - String Grouping period: day, week, or month. Defaults to week.

Example

Query
query goalProgressData(
  $id: ID!,
  $lookbackDays: Int,
  $period: String
) {
  goalProgressData(
    id: $id,
    lookbackDays: $lookbackDays,
    period: $period
  ) {
    averagePerWeek
    dataPoints {
      ...ProgressDataPointFragment
    }
    pace
    streakData {
      ...ProgressDataPointFragment
    }
    totalEvents
  }
}
Variables
{
  "id": 4,
  "lookbackDays": 987,
  "period": "abc123"
}
Response
{
  "data": {
    "goalProgressData": {
      "averagePerWeek": 987.65,
      "dataPoints": [ProgressDataPoint],
      "pace": "xyz789",
      "streakData": [ProgressDataPoint],
      "totalEvents": 987
    }
  }
}

goalSummary

Description

Aggregated KPI counts for the current user's goals.

Response

Returns a GoalSummary!

Example

Query
query goalSummary {
  goalSummary {
    avgProgress
    completedCount
    completedThisYearCount
    needAttentionCount
    onTrackCount
    totalGoals
  }
}
Response
{
  "data": {
    "goalSummary": {
      "avgProgress": 987.65,
      "completedCount": 987,
      "completedThisYearCount": 987,
      "needAttentionCount": 123,
      "onTrackCount": 123,
      "totalGoals": 123
    }
  }
}

goalTemplates

Description

Returns all non-deleted goal templates ordered by (theme, display_order). Auth required.

Response

Returns [GoalTemplate!]!

Example

Query
query goalTemplates {
  goalTemplates {
    category {
      ...GoalCategoryFragment
    }
    description
    displayOrder
    estimatedDurationDays
    imageUrl
    kind {
      ...GoalTypeFragment
    }
    milestones {
      ...GoalTemplateMilestoneFragment
    }
    name
    practices {
      ...GoalTemplatePracticeFragment
    }
    publicId
    theme
  }
}
Response
{
  "data": {
    "goalTemplates": [
      {
        "category": GoalCategory,
        "description": "xyz789",
        "displayOrder": 987,
        "estimatedDurationDays": 987,
        "imageUrl": "xyz789",
        "kind": GoalType,
        "milestones": [GoalTemplateMilestone],
        "name": "abc123",
        "practices": [GoalTemplatePractice],
        "publicId": 4,
        "theme": "abc123"
      }
    ]
  }
}

goals

Description

Lists top-level goals (no parent) for the authenticated user or a specified user (admin only).

Response

Returns [Goal!]

Arguments
Name Description
userId - ID public_id of the user whose goals to retrieve. Omit to use the current user.

Example

Query
query goals($userId: ID) {
  goals(userId: $userId) {
    allEvents {
      ...GoalEventFragment
    }
    appLink
    averageCheckInTime
    calendarMonth {
      ...GoalCalendarMonthFragment
    }
    category {
      ...GoalCategoryFragment
    }
    challenge {
      ...GoalChallengeFragment
    }
    chapters {
      ...GoalChapterFragment
    }
    checkedInToday
    collectiveGoalContribution {
      ...GoalCollectiveContributionFragment
    }
    comments {
      ...GoalEventCommentFragment
    }
    completed
    completedAtTime
    completionRate
    completionReflection
    content
    continuesGoal {
      ...GoalFragment
    }
    createdAtTime
    currentAmount
    dayOfWeekDistribution
    daysToUpdate
    demo
    dueToday
    durationMinutes
    encouragedBy {
      ...EncouragedByFragment
    }
    encouragements {
      ...GoalEventEncouragementFragment
    }
    events {
      ...GoalEventFragment
    }
    followersCount
    fromTemplate {
      ...GoalTemplateFragment
    }
    fromTemplateName
    habitCompletions {
      ...HabitCompletionFragment
    }
    habitStreak
    habitStreakUnit
    identityPrompt
    imageUrl
    journeyRecap {
      ...JourneyRecapFragment
    }
    kind {
      ...GoalTypeFragment
    }
    lastCheckedInDate
    lifeArea
    lockVersion
    longestHabitStreak
    milestones {
      ...GoalFragment
    }
    name
    nonAllyFollowersCount
    parentGoalId
    pastAttemptContext
    position
    practiceWeek {
      ...PracticeWeekFragment
    }
    practices {
      ...GoalFragment
    }
    preBreakHabitStreak
    private
    publicId
    quickUpdatePrompts
    recurrenceDays
    recurrenceInterval
    recurrenceType
    sharedWithPartner
    status
    streakFreezesAvailable
    streakFreezesUsed
    streakRepairEligibleUntil
    streakRepairedCount
    successorGoal {
      ...GoalFragment
    }
    successorOffer {
      ...SuccessorOfferFragment
    }
    supportsGoal {
      ...GoalFragment
    }
    targetAmount
    targetDateTime
    totalCheckIns
    unit
    updatedAtTime
    user {
      ...UserFragment
    }
    viewerCheeredToday
    visibility
    weeklyTarget
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "goals": [
      {
        "allEvents": [GoalEvent],
        "appLink": "abc123",
        "averageCheckInTime": 123.45,
        "calendarMonth": GoalCalendarMonth,
        "category": GoalCategory,
        "challenge": GoalChallenge,
        "chapters": [GoalChapter],
        "checkedInToday": false,
        "collectiveGoalContribution": GoalCollectiveContribution,
        "comments": [GoalEventComment],
        "completed": false,
        "completedAtTime": "abc123",
        "completionRate": 123.45,
        "completionReflection": "xyz789",
        "content": "xyz789",
        "continuesGoal": Goal,
        "createdAtTime": "xyz789",
        "currentAmount": 123.45,
        "dayOfWeekDistribution": [987],
        "daysToUpdate": 123,
        "demo": false,
        "dueToday": false,
        "durationMinutes": 123,
        "encouragedBy": EncouragedBy,
        "encouragements": [GoalEventEncouragement],
        "events": [GoalEvent],
        "followersCount": 123,
        "fromTemplate": GoalTemplate,
        "fromTemplateName": "abc123",
        "habitCompletions": [HabitCompletion],
        "habitStreak": 987,
        "habitStreakUnit": "DAY",
        "identityPrompt": "xyz789",
        "imageUrl": "xyz789",
        "journeyRecap": JourneyRecap,
        "kind": GoalType,
        "lastCheckedInDate": "xyz789",
        "lifeArea": "abc123",
        "lockVersion": 123,
        "longestHabitStreak": 987,
        "milestones": [Goal],
        "name": "abc123",
        "nonAllyFollowersCount": 123,
        "parentGoalId": "abc123",
        "pastAttemptContext": "abc123",
        "position": 987,
        "practiceWeek": PracticeWeek,
        "practices": [Goal],
        "preBreakHabitStreak": 987,
        "private": true,
        "publicId": "4",
        "quickUpdatePrompts": ["xyz789"],
        "recurrenceDays": ["abc123"],
        "recurrenceInterval": 987,
        "recurrenceType": "abc123",
        "sharedWithPartner": false,
        "status": "completed",
        "streakFreezesAvailable": 123,
        "streakFreezesUsed": 987,
        "streakRepairEligibleUntil": "abc123",
        "streakRepairedCount": 123,
        "successorGoal": Goal,
        "successorOffer": SuccessorOffer,
        "supportsGoal": Goal,
        "targetAmount": 987.65,
        "targetDateTime": "abc123",
        "totalCheckIns": 123,
        "unit": "xyz789",
        "updatedAtTime": "xyz789",
        "user": User,
        "viewerCheeredToday": true,
        "visibility": "ALLIES",
        "weeklyTarget": 123
      }
    ]
  }
}

hasCoachHistory

Description

Whether the authenticated user has sent or received at least one Coach message, across any conversation (general or goal-scoped). Requires auth.

Response

Returns a Boolean!

Example

Query
query hasCoachHistory {
  hasCoachHistory
}
Response
{"data": {"hasCoachHistory": true}}

headCoachBrief

Description

Super-admin only, behind the head_coach_enabled kill switch. The deterministic morning brief (cached for 5 minutes per admin): what needs attention, GDPR deadlines, failed runs, health.

Response

Returns a HeadCoachBrief!

Example

Query
query headCoachBrief {
  headCoachBrief {
    doneToday {
      ...HeadCoachBriefDoneTodayFragment
    }
    failedRuns {
      ...HeadCoachBriefFailedRunsFragment
    }
    gdprDeadlines {
      ...HeadCoachBriefGdprFragment
    }
    generatedAt
    health {
      ...HeadCoachBriefHealthFragment
    }
    needsYou {
      ...HeadCoachBriefItemFragment
    }
    running {
      ...HeadCoachBriefRunningFragment
    }
  }
}
Response
{
  "data": {
    "headCoachBrief": {
      "doneToday": HeadCoachBriefDoneToday,
      "failedRuns": HeadCoachBriefFailedRuns,
      "gdprDeadlines": HeadCoachBriefGdpr,
      "generatedAt": ISO8601DateTime,
      "health": HeadCoachBriefHealth,
      "needsYou": [HeadCoachBriefItem],
      "running": HeadCoachBriefRunning
    }
  }
}

headCoachBulkRun

Description

Live progress of a bulk run the caller started. Nil for a foreign, unknown or expired run.

Response

Returns a HeadCoachBulkRun

Arguments
Name Description
actionId - ID! public_id of the start_bulk_run action (the run id).

Example

Query
query headCoachBulkRun($actionId: ID!) {
  headCoachBulkRun(actionId: $actionId) {
    actionId
    control
    cursor
    errors
    failed
    finishedAt
    itemTool
    startedAt
    status
    succeeded
    total
  }
}
Variables
{"actionId": 4}
Response
{
  "data": {
    "headCoachBulkRun": {
      "actionId": 4,
      "control": "xyz789",
      "cursor": 987,
      "errors": ["abc123"],
      "failed": 123,
      "finishedAt": ISO8601DateTime,
      "itemTool": "abc123",
      "startedAt": ISO8601DateTime,
      "status": "abc123",
      "succeeded": 123,
      "total": 987
    }
  }
}

headCoachConversation

Description

One of the caller's own conversations with its visible messages. Nil for a foreign or unknown id.

Response

Returns a HeadCoachConversation

Arguments
Name Description
id - ID! public_id of the conversation.

Example

Query
query headCoachConversation($id: ID!) {
  headCoachConversation(id: $id) {
    activeTurn {
      ...HeadCoachTurnFragment
    }
    createdAt
    id
    lastTurnAt
    messages {
      ...HeadCoachMessageFragment
    }
    title
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "headCoachConversation": {
      "activeTurn": HeadCoachTurn,
      "createdAt": ISO8601DateTime,
      "id": "4",
      "lastTurnAt": ISO8601DateTime,
      "messages": [HeadCoachMessage],
      "title": "abc123"
    }
  }
}

headCoachConversations

Description

Super-admin only, behind the head_coach_enabled kill switch. The caller's own conversations, most recent first.

Response

Returns [HeadCoachConversation!]!

Example

Query
query headCoachConversations {
  headCoachConversations {
    activeTurn {
      ...HeadCoachTurnFragment
    }
    createdAt
    id
    lastTurnAt
    messages {
      ...HeadCoachMessageFragment
    }
    title
  }
}
Response
{
  "data": {
    "headCoachConversations": [
      {
        "activeTurn": HeadCoachTurn,
        "createdAt": ISO8601DateTime,
        "id": "4",
        "lastTurnAt": ISO8601DateTime,
        "messages": [HeadCoachMessage],
        "title": "xyz789"
      }
    ]
  }
}

headCoachTurn

Description

Poll a turn: its status plus visible messages with seq greater than afterSeq. Nil for a foreign or unknown id.

Response

Returns a HeadCoachTurnPoll

Arguments
Name Description
afterSeq - Int Only return messages after this seq. Default = 0
id - ID! public_id of the turn.

Example

Query
query headCoachTurn(
  $afterSeq: Int,
  $id: ID!
) {
  headCoachTurn(
    afterSeq: $afterSeq,
    id: $id
  ) {
    messages {
      ...HeadCoachMessageFragment
    }
    turn {
      ...HeadCoachTurnFragment
    }
  }
}
Variables
{"afterSeq": 0, "id": 4}
Response
{
  "data": {
    "headCoachTurn": {
      "messages": [HeadCoachMessage],
      "turn": HeadCoachTurn
    }
  }
}

isFollowingGoal

Description

Checks whether the authenticated user is currently following a goal.

Response

Returns a Result

Arguments
Name Description
id - ID! public_id of the goal to check.

Example

Query
query isFollowingGoal($id: ID!) {
  isFollowingGoal(id: $id) {
    success
  }
}
Variables
{"id": "4"}
Response
{"data": {"isFollowingGoal": {"success": true}}}

marketingCapabilities

Description

Plain-language skills a marketing agent can be given, with the brand-voice check marked locked.

Response

Returns [MarketingCapability!]!

Example

Query
query marketingCapabilities {
  marketingCapabilities {
    appliesTo
    description
    label
    locked
    slug
  }
}
Response
{
  "data": {
    "marketingCapabilities": [
      {
        "appliesTo": ["xyz789"],
        "description": "abc123",
        "label": "xyz789",
        "locked": false,
        "slug": "xyz789"
      }
    ]
  }
}

marketingCrewBudget

Description

Aggregate monthly budget for the marketing crew: the ceiling, what has been spent this month, and when it resets.

Response

Returns a MarketingCrewBudget!

Example

Query
query marketingCrewBudget {
  marketingCrewBudget {
    limitCents
    resetsOn
    spentCents
  }
}
Response
{
  "data": {
    "marketingCrewBudget": {
      "limitCents": 987,
      "resetsOn": ISO8601Date,
      "spentCents": 123
    }
  }
}

marketingSocialChannels

Description

Each supported social network and its Buffer account status, from the cached Buffer sync. Never calls Buffer; every status is UNKNOWN until a sync lands.

Response

Returns [MarketingSocialChannel!]!

Example

Query
query marketingSocialChannels {
  marketingSocialChannels {
    avatarUrl
    checkedAt
    displayName
    handle
    key
    overrideMatchesBuffer
    source
    status
  }
}
Response
{
  "data": {
    "marketingSocialChannels": [
      {
        "avatarUrl": "xyz789",
        "checkedAt": ISO8601DateTime,
        "displayName": "abc123",
        "handle": "abc123",
        "key": "xyz789",
        "overrideMatchesBuffer": true,
        "source": "BUFFER",
        "status": "AMBIGUOUS"
      }
    ]
  }
}

me

Description

Returns the currently authenticated user. Requires authentication.

Response

Returns a User

Example

Query
query me {
  me {
    achievementStats {
      ...AchievementStatsFragment
    }
    actions {
      ...UserActionFragment
    }
    admin
    adminRoles
    badgeActions {
      ...UserActionFragment
    }
    celebrationPreferences {
      ...CelebrationPreferencesFragment
    }
    charterMarkerHidden
    charterMemberSince
    charterNotesEnabled
    coachingPreferences {
      ...CoachingPreferencesFragment
    }
    colorTheme
    completedCommunityChallenges {
      ...ChallengeParticipantFragment
    }
    completedSeasonalEvents {
      ...SeasonalEventParticipantFragment
    }
    createdAtTime
    currentInsights {
      ...InsightPackFragment
    }
    dashboardPreferences {
      ...DashboardPreferencesFragment
    }
    dayClosedToday
    daysShownUp
    daysSinceLastActive
    demo
    details {
      ...UserDetailFragment
    }
    email
    emailVerified
    featureTourStatus
    feedItems {
      ...UserFeedItemFragment
    }
    firstName
    goItAlone
    goalDayContext {
      ...GoalDayContextFragment
    }
    goalDayLog {
      ...GoalDayLogEntryFragment
    }
    goalDaySummaries {
      ...GoalDaySummaryFragment
    }
    goalMotivationProfile {
      ...GoalMotivationProfileFragment
    }
    goals {
      ...GoalFragment
    }
    graceDays
    hasAlly
    hasCreatedFromTemplate
    hasDigestEnabled
    isSupporter
    lastDigestSentAt
    lastName
    latestEnneagramAssessment {
      ...EnneagramAssessmentFragment
    }
    level
    longestStreak
    moodGoalInsight {
      ...InsightPackFragment
    }
    nextLevelThreshold
    nextOnTheShelfBadge {
      ...NextBadgeFragment
    }
    notifications {
      ...UserNotificationFragment
    }
    onboardingStatus {
      ...OnboardingStatusFragment
    }
    paceSuggestion {
      ...PaceSuggestionFragment
    }
    photo {
      ...UserPhotoFragment
    }
    practiceInviteDismissedAt
    privateMode
    progressToNextLevel
    publicId
    recentlyUnlockedBadges {
      ...RecentlyUnlockedBadgeFragment
    }
    requiredCheckinsCompleteToday
    reverseNudge {
      ...ReverseNudgeFragment
    }
    showcasedAchievements
    signInDates
    signupAgeDays
    stats {
      ...UserStatsFragment
    }
    streak
    streakJourney {
      ...StreakJourneyFragment
    }
    streakRecountNotePending
    streakRepairOffer {
      ...StreakRepairOfferFragment
    }
    streakRescueDays {
      ...StreakRescueDayFragment
    }
    supporterCancelAtPeriodEnd
    supporterMoments {
      ...SupporterMomentsFragment
    }
    supporterTier
    supporterUntil
    timeToFirstGoalSeconds
    todaysMood
    unlockedAchievementKeys
    updatedAtTime
    username
    welcomeBackOffer {
      ...WelcomeBackOfferFragment
    }
    xp
  }
}
Response
{
  "data": {
    "me": {
      "achievementStats": AchievementStats,
      "actions": [UserAction],
      "admin": false,
      "adminRoles": ["xyz789"],
      "badgeActions": [UserAction],
      "celebrationPreferences": CelebrationPreferences,
      "charterMarkerHidden": true,
      "charterMemberSince": ISO8601DateTime,
      "charterNotesEnabled": true,
      "coachingPreferences": CoachingPreferences,
      "colorTheme": "xyz789",
      "completedCommunityChallenges": [
        ChallengeParticipant
      ],
      "completedSeasonalEvents": [
        SeasonalEventParticipant
      ],
      "createdAtTime": "xyz789",
      "currentInsights": [InsightPack],
      "dashboardPreferences": DashboardPreferences,
      "dayClosedToday": false,
      "daysShownUp": 123,
      "daysSinceLastActive": 123,
      "demo": false,
      "details": UserDetail,
      "email": "xyz789",
      "emailVerified": false,
      "featureTourStatus": {},
      "feedItems": [UserFeedItem],
      "firstName": "abc123",
      "goItAlone": false,
      "goalDayContext": GoalDayContext,
      "goalDayLog": [GoalDayLogEntry],
      "goalDaySummaries": [GoalDaySummary],
      "goalMotivationProfile": GoalMotivationProfile,
      "goals": [Goal],
      "graceDays": ["abc123"],
      "hasAlly": false,
      "hasCreatedFromTemplate": false,
      "hasDigestEnabled": true,
      "isSupporter": true,
      "lastDigestSentAt": "abc123",
      "lastName": "xyz789",
      "latestEnneagramAssessment": EnneagramAssessment,
      "level": 987,
      "longestStreak": 123,
      "moodGoalInsight": InsightPack,
      "nextLevelThreshold": 987,
      "nextOnTheShelfBadge": NextBadge,
      "notifications": [UserNotification],
      "onboardingStatus": OnboardingStatus,
      "paceSuggestion": PaceSuggestion,
      "photo": UserPhoto,
      "practiceInviteDismissedAt": "xyz789",
      "privateMode": true,
      "progressToNextLevel": 987.65,
      "publicId": 4,
      "recentlyUnlockedBadges": [RecentlyUnlockedBadge],
      "requiredCheckinsCompleteToday": true,
      "reverseNudge": ReverseNudge,
      "showcasedAchievements": ["xyz789"],
      "signInDates": ["xyz789"],
      "signupAgeDays": 123,
      "stats": UserStats,
      "streak": 987,
      "streakJourney": StreakJourney,
      "streakRecountNotePending": true,
      "streakRepairOffer": StreakRepairOffer,
      "streakRescueDays": [StreakRescueDay],
      "supporterCancelAtPeriodEnd": false,
      "supporterMoments": SupporterMoments,
      "supporterTier": "abc123",
      "supporterUntil": ISO8601DateTime,
      "timeToFirstGoalSeconds": 987,
      "todaysMood": "xyz789",
      "unlockedAchievementKeys": ["abc123"],
      "updatedAtTime": "xyz789",
      "username": "abc123",
      "welcomeBackOffer": WelcomeBackOffer,
      "xp": 123
    }
  }
}

moderationQueue

Description

Admin only. Pending moderation flags, cursor-paginated.

Response

Returns a ContentFlagConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
ageBucket - String Single-select age bucket: under_1h|under_24h|under_7d|older_than_7d.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
flaggableType - [String!] Filter by polymorphic flaggable class name (e.g. CommunityPost).
flaggedUserId - String Public_id of the user whose flagged content should be returned.
last - Int Returns the last n elements from the list.
severity - [String!] Filter by severity: low|medium|high|critical. Multi-select ORs within; AND with other filters.
source - [String!] Filter by source: profanity_filter|ai_screen|user_report.

Example

Query
query moderationQueue(
  $after: String,
  $ageBucket: String,
  $before: String,
  $first: Int,
  $flaggableType: [String!],
  $flaggedUserId: String,
  $last: Int,
  $severity: [String!],
  $source: [String!]
) {
  moderationQueue(
    after: $after,
    ageBucket: $ageBucket,
    before: $before,
    first: $first,
    flaggableType: $flaggableType,
    flaggedUserId: $flaggedUserId,
    last: $last,
    severity: $severity,
    source: $source
  ) {
    edges {
      ...ContentFlagEdgeFragment
    }
    nodes {
      ...ContentFlagFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "ageBucket": "xyz789",
  "before": "abc123",
  "first": 123,
  "flaggableType": ["xyz789"],
  "flaggedUserId": "abc123",
  "last": 123,
  "severity": ["abc123"],
  "source": ["xyz789"]
}
Response
{
  "data": {
    "moderationQueue": {
      "edges": [ContentFlagEdge],
      "nodes": [ContentFlag],
      "pageInfo": PageInfo
    }
  }
}

myAllyInvites

Description

Returns the authenticated user's active accountability-partner invites. Auth required.

Response

Returns [AllyInvite!]!

Example

Query
query myAllyInvites {
  myAllyInvites {
    createdAt
    expiresAt
    id
    status
    token
  }
}
Response
{
  "data": {
    "myAllyInvites": [
      {
        "createdAt": ISO8601DateTime,
        "expiresAt": ISO8601DateTime,
        "id": "4",
        "status": "xyz789",
        "token": "abc123"
      }
    ]
  }
}

myLatestDataExport

Description

Returns the most recent self-service data export request for the authenticated user.

Response

Returns a GdprRequest

Example

Query
query myLatestDataExport {
  myLatestDataExport {
    cascadePreview {
      ...CascadePreviewFragment
    }
    dueBy
    exportExpiresAt
    exportFileUrl
    fulfilledAt
    fulfilledBy {
      ...UserFragment
    }
    notes
    publicId
    receivedAt
    requestType
    requestorEmail
    status
  }
}
Response
{
  "data": {
    "myLatestDataExport": {
      "cascadePreview": CascadePreview,
      "dueBy": ISO8601DateTime,
      "exportExpiresAt": ISO8601DateTime,
      "exportFileUrl": "abc123",
      "fulfilledAt": ISO8601DateTime,
      "fulfilledBy": User,
      "notes": "xyz789",
      "publicId": "xyz789",
      "receivedAt": ISO8601DateTime,
      "requestType": "abc123",
      "requestorEmail": "abc123",
      "status": "xyz789"
    }
  }
}

myPacts

Description

Pacts the current user is an invited or joined member of. Auth required.

Response

Returns [Pact!]!

Example

Query
query myPacts {
  myPacts {
    boardMembers {
      ...PactBoardMemberFragment
    }
    coachNote
    createdAtTime
    creator {
      ...UserFragment
    }
    dayNumber
    daysPerWeek
    endsOn
    finalizedAt
    graceDays
    lengthDays
    missPolicy
    name
    nextWaypoint
    pactMemberships {
      ...PactMembershipFragment
    }
    pactRules {
      ...PactRuleFragment
    }
    publicId
    restartBannerVisible
    shape
    sharedTotal
    stakes
    startsOn
    status
    takeoverEligible
    templateKey
    timezone
    todayDecided
    togetherDays
    totalTarget
    totalUnit
    updatedAtTime
    viewerMembership {
      ...PactMembershipFragment
    }
    visibility
  }
}
Response
{
  "data": {
    "myPacts": [
      {
        "boardMembers": [PactBoardMember],
        "coachNote": "abc123",
        "createdAtTime": "abc123",
        "creator": User,
        "dayNumber": 123,
        "daysPerWeek": 987,
        "endsOn": ISO8601Date,
        "finalizedAt": ISO8601DateTime,
        "graceDays": 987,
        "lengthDays": 987,
        "missPolicy": "xyz789",
        "name": "xyz789",
        "nextWaypoint": 123.45,
        "pactMemberships": [PactMembership],
        "pactRules": [PactRule],
        "publicId": "4",
        "restartBannerVisible": false,
        "shape": "xyz789",
        "sharedTotal": 123.45,
        "stakes": "xyz789",
        "startsOn": ISO8601Date,
        "status": "xyz789",
        "takeoverEligible": true,
        "templateKey": "xyz789",
        "timezone": "abc123",
        "todayDecided": false,
        "togetherDays": 987,
        "totalTarget": 123.45,
        "totalUnit": "xyz789",
        "updatedAtTime": "xyz789",
        "viewerMembership": PactMembership,
        "visibility": "abc123"
      }
    ]
  }
}

myTeam

Description

The authenticated user's Team, if any. Null when the user has no team membership.

Response

Returns a Team

Example

Query
query myTeam {
  myTeam {
    billingOwner {
      ...UserFragment
    }
    coachName
    memberCount
    memberships {
      ...TeamMembershipFragment
    }
    name
    publicId
    slug
    subscription {
      ...TeamSubscriptionFragment
    }
  }
}
Response
{
  "data": {
    "myTeam": {
      "billingOwner": User,
      "coachName": "xyz789",
      "memberCount": 987,
      "memberships": [TeamMembership],
      "name": "xyz789",
      "publicId": "4",
      "slug": "xyz789",
      "subscription": TeamSubscription
    }
  }
}

myTeamActivity

Description

The viewer's own team activity row, identical to what teamMemberActivity returns an owner or admin for them. Takes no member argument. Null when the team does not exist or the caller is not seated on it.

Response

Returns a TeamMemberActivity

Arguments
Name Description
teamId - String!

Example

Query
query myTeamActivity($teamId: String!) {
  myTeamActivity(teamId: $teamId) {
    collectiveGoalContributions
    lastActiveDays
    lastActiveLabel
    optedOut
    periodStats {
      ...TeamMemberActivityPeriodStatFragment
    }
    subCommunityNames
  }
}
Variables
{"teamId": "abc123"}
Response
{
  "data": {
    "myTeamActivity": {
      "collectiveGoalContributions": 123,
      "lastActiveDays": 123,
      "lastActiveLabel": "xyz789",
      "optedOut": false,
      "periodStats": [TeamMemberActivityPeriodStat],
      "subCommunityNames": ["xyz789"]
    }
  }
}

myTeams

Description

Every team the authenticated user belongs to, ordered joined_at ASC. Backs the team-picker switcher (OBJ-1821). Empty array, never null, for a user with no memberships.

Response

Returns [TeamSwitcherEntry!]!

Example

Query
query myTeams {
  myTeams {
    role
    team {
      ...TeamFragment
    }
  }
}
Response
{
  "data": {
    "myTeams": [
      {
        "role": "abc123",
        "team": Team
      }
    ]
  }
}

notificationHistory

Description

Returns paginated notification history for the current user, newest first.

Response

Returns a NotificationHistory

Arguments
Name Description
limit - Int Number of notifications per page. Defaults to 20.
offset - Int Number of items to skip for pagination. Defaults to 0.
teamId - ID When present, scopes results to notifications for this team. A non-member gets an empty result.

Example

Query
query notificationHistory(
  $limit: Int,
  $offset: Int,
  $teamId: ID
) {
  notificationHistory(
    limit: $limit,
    offset: $offset,
    teamId: $teamId
  ) {
    hasMore
    items {
      ...UserNotificationFragment
    }
    totalCount
    unreadCount
  }
}
Variables
{"limit": 123, "offset": 987, "teamId": 4}
Response
{
  "data": {
    "notificationHistory": {
      "hasMore": true,
      "items": [UserNotification],
      "totalCount": 123,
      "unreadCount": 123
    }
  }
}

outgoingAllyRequests

Description

Returns pending ally requests the authenticated user has sent. Auth required.

Response

Returns [UserSearchResult!]!

Example

Query
query outgoingAllyRequests {
  outgoingAllyRequests {
    achievementStats {
      ...AchievementStatsFragment
    }
    actions {
      ...UserActionFragment
    }
    admin
    adminRoles
    allyStatus
    badgeActions {
      ...UserActionFragment
    }
    celebrationPreferences {
      ...CelebrationPreferencesFragment
    }
    charterMarkerHidden
    charterMemberSince
    charterNotesEnabled
    coachingPreferences {
      ...CoachingPreferencesFragment
    }
    colorTheme
    completedCommunityChallenges {
      ...ChallengeParticipantFragment
    }
    completedSeasonalEvents {
      ...SeasonalEventParticipantFragment
    }
    createdAtTime
    currentInsights {
      ...InsightPackFragment
    }
    dashboardPreferences {
      ...DashboardPreferencesFragment
    }
    dayClosedToday
    daysShownUp
    daysSinceLastActive
    demo
    details {
      ...UserDetailFragment
    }
    email
    emailVerified
    featureTourStatus
    feedItems {
      ...UserFeedItemFragment
    }
    firstName
    goItAlone
    goalDayContext {
      ...GoalDayContextFragment
    }
    goalDayLog {
      ...GoalDayLogEntryFragment
    }
    goalDaySummaries {
      ...GoalDaySummaryFragment
    }
    goalMotivationProfile {
      ...GoalMotivationProfileFragment
    }
    goals {
      ...GoalFragment
    }
    graceDays
    hasAlly
    hasCreatedFromTemplate
    hasDigestEnabled
    isSupporter
    lastDigestSentAt
    lastName
    latestEnneagramAssessment {
      ...EnneagramAssessmentFragment
    }
    level
    longestStreak
    moodGoalInsight {
      ...InsightPackFragment
    }
    nextLevelThreshold
    nextOnTheShelfBadge {
      ...NextBadgeFragment
    }
    notifications {
      ...UserNotificationFragment
    }
    onboardingStatus {
      ...OnboardingStatusFragment
    }
    paceSuggestion {
      ...PaceSuggestionFragment
    }
    photo {
      ...UserPhotoFragment
    }
    practiceInviteDismissedAt
    privateMode
    progressToNextLevel
    publicId
    recentlyUnlockedBadges {
      ...RecentlyUnlockedBadgeFragment
    }
    requiredCheckinsCompleteToday
    reverseNudge {
      ...ReverseNudgeFragment
    }
    showcasedAchievements
    signInDates
    signupAgeDays
    stats {
      ...UserStatsFragment
    }
    streak
    streakJourney {
      ...StreakJourneyFragment
    }
    streakRecountNotePending
    streakRepairOffer {
      ...StreakRepairOfferFragment
    }
    streakRescueDays {
      ...StreakRescueDayFragment
    }
    supporterCancelAtPeriodEnd
    supporterMoments {
      ...SupporterMomentsFragment
    }
    supporterTier
    supporterUntil
    timeToFirstGoalSeconds
    todaysMood
    unlockedAchievementKeys
    updatedAtTime
    username
    welcomeBackOffer {
      ...WelcomeBackOfferFragment
    }
    xp
  }
}
Response
{
  "data": {
    "outgoingAllyRequests": [
      {
        "achievementStats": AchievementStats,
        "actions": [UserAction],
        "admin": true,
        "adminRoles": ["xyz789"],
        "allyStatus": "ACCEPTED",
        "badgeActions": [UserAction],
        "celebrationPreferences": CelebrationPreferences,
        "charterMarkerHidden": true,
        "charterMemberSince": ISO8601DateTime,
        "charterNotesEnabled": false,
        "coachingPreferences": CoachingPreferences,
        "colorTheme": "abc123",
        "completedCommunityChallenges": [
          ChallengeParticipant
        ],
        "completedSeasonalEvents": [
          SeasonalEventParticipant
        ],
        "createdAtTime": "xyz789",
        "currentInsights": [InsightPack],
        "dashboardPreferences": DashboardPreferences,
        "dayClosedToday": false,
        "daysShownUp": 987,
        "daysSinceLastActive": 123,
        "demo": false,
        "details": UserDetail,
        "email": "xyz789",
        "emailVerified": false,
        "featureTourStatus": {},
        "feedItems": [UserFeedItem],
        "firstName": "xyz789",
        "goItAlone": true,
        "goalDayContext": GoalDayContext,
        "goalDayLog": [GoalDayLogEntry],
        "goalDaySummaries": [GoalDaySummary],
        "goalMotivationProfile": GoalMotivationProfile,
        "goals": [Goal],
        "graceDays": ["xyz789"],
        "hasAlly": true,
        "hasCreatedFromTemplate": true,
        "hasDigestEnabled": false,
        "isSupporter": true,
        "lastDigestSentAt": "xyz789",
        "lastName": "abc123",
        "latestEnneagramAssessment": EnneagramAssessment,
        "level": 123,
        "longestStreak": 987,
        "moodGoalInsight": InsightPack,
        "nextLevelThreshold": 123,
        "nextOnTheShelfBadge": NextBadge,
        "notifications": [UserNotification],
        "onboardingStatus": OnboardingStatus,
        "paceSuggestion": PaceSuggestion,
        "photo": UserPhoto,
        "practiceInviteDismissedAt": "abc123",
        "privateMode": true,
        "progressToNextLevel": 123.45,
        "publicId": "4",
        "recentlyUnlockedBadges": [RecentlyUnlockedBadge],
        "requiredCheckinsCompleteToday": true,
        "reverseNudge": ReverseNudge,
        "showcasedAchievements": ["abc123"],
        "signInDates": ["abc123"],
        "signupAgeDays": 123,
        "stats": UserStats,
        "streak": 987,
        "streakJourney": StreakJourney,
        "streakRecountNotePending": false,
        "streakRepairOffer": StreakRepairOffer,
        "streakRescueDays": [StreakRescueDay],
        "supporterCancelAtPeriodEnd": false,
        "supporterMoments": SupporterMoments,
        "supporterTier": "xyz789",
        "supporterUntil": ISO8601DateTime,
        "timeToFirstGoalSeconds": 123,
        "todaysMood": "xyz789",
        "unlockedAchievementKeys": [
          "abc123"
        ],
        "updatedAtTime": "abc123",
        "username": "abc123",
        "welcomeBackOffer": WelcomeBackOffer,
        "xp": 123
      }
    ]
  }
}

pact

Description

Fetches a Pact by public_id. Null for a non-member.

Response

Returns a Pact

Arguments
Name Description
id - ID! public_id of the Pact.

Example

Query
query pact($id: ID!) {
  pact(id: $id) {
    boardMembers {
      ...PactBoardMemberFragment
    }
    coachNote
    createdAtTime
    creator {
      ...UserFragment
    }
    dayNumber
    daysPerWeek
    endsOn
    finalizedAt
    graceDays
    lengthDays
    missPolicy
    name
    nextWaypoint
    pactMemberships {
      ...PactMembershipFragment
    }
    pactRules {
      ...PactRuleFragment
    }
    publicId
    restartBannerVisible
    shape
    sharedTotal
    stakes
    startsOn
    status
    takeoverEligible
    templateKey
    timezone
    todayDecided
    togetherDays
    totalTarget
    totalUnit
    updatedAtTime
    viewerMembership {
      ...PactMembershipFragment
    }
    visibility
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "pact": {
      "boardMembers": [PactBoardMember],
      "coachNote": "abc123",
      "createdAtTime": "abc123",
      "creator": User,
      "dayNumber": 123,
      "daysPerWeek": 123,
      "endsOn": ISO8601Date,
      "finalizedAt": ISO8601DateTime,
      "graceDays": 987,
      "lengthDays": 987,
      "missPolicy": "abc123",
      "name": "xyz789",
      "nextWaypoint": 123.45,
      "pactMemberships": [PactMembership],
      "pactRules": [PactRule],
      "publicId": 4,
      "restartBannerVisible": false,
      "shape": "abc123",
      "sharedTotal": 987.65,
      "stakes": "xyz789",
      "startsOn": ISO8601Date,
      "status": "xyz789",
      "takeoverEligible": false,
      "templateKey": "abc123",
      "timezone": "xyz789",
      "todayDecided": true,
      "togetherDays": 123,
      "totalTarget": 987.65,
      "totalUnit": "xyz789",
      "updatedAtTime": "abc123",
      "viewerMembership": PactMembership,
      "visibility": "abc123"
    }
  }
}

pactInvite

Description

Fetches the viewer's own invite (a PactMembership) by its public_id.

Response

Returns a PactMembership

Arguments
Name Description
id - ID! public_id of the PactMembership.

Example

Query
query pactInvite($id: ID!) {
  pactInvite(id: $id) {
    blocked
    celebrationSeen
    celebrationSeenAt
    completedAt
    daysDone
    expired
    joinedOn
    linkedGoal {
      ...GoalFragment
    }
    needsReconfirm
    oneTotalAmount
    pact {
      ...PactFragment
    }
    publicId
    role
    status
    steppedOutAt
    user {
      ...UserFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "pactInvite": {
      "blocked": false,
      "celebrationSeen": true,
      "celebrationSeenAt": ISO8601DateTime,
      "completedAt": ISO8601DateTime,
      "daysDone": 123,
      "expired": true,
      "joinedOn": ISO8601Date,
      "linkedGoal": Goal,
      "needsReconfirm": true,
      "oneTotalAmount": 123.45,
      "pact": Pact,
      "publicId": 4,
      "role": "abc123",
      "status": "xyz789",
      "steppedOutAt": ISO8601DateTime,
      "user": User
    }
  }
}

pactTemplates

Description

D12 — the 17 starter templates, each with its Coach size estimate. Auth required.

Response

Returns [PactTemplate!]!

Example

Query
query pactTemplates {
  pactTemplates {
    daysPerWeek
    graceDays
    key
    lengthDays
    missPolicy
    name
    rules {
      ...PactTemplateRuleFragment
    }
    shape
    sizeEstimate {
      ...PactSizeEstimateFragment
    }
    totalTarget
    totalUnit
    visibility
  }
}
Response
{
  "data": {
    "pactTemplates": [
      {
        "daysPerWeek": 987,
        "graceDays": 123,
        "key": "xyz789",
        "lengthDays": 123,
        "missPolicy": "abc123",
        "name": "abc123",
        "rules": [PactTemplateRule],
        "shape": "xyz789",
        "sizeEstimate": PactSizeEstimate,
        "totalTarget": 123.45,
        "totalUnit": "xyz789",
        "visibility": "abc123"
      }
    ]
  }
}

pendingAllyRequests

Description

Returns incoming pending ally requests for the authenticated user. Auth required.

Response

Returns [UserAlly!]!

Example

Query
query pendingAllyRequests {
  pendingAllyRequests {
    accountabilityPartner
    accountabilityPartnerSince
    checkedInToday
    createdAtTime
    firstName
    id
    lastName
    mutualCount
    mutualStreakCount
    partnerRequestedByMe
    partnerStatus
    photo {
      ...UserPhotoFragment
    }
    publicId
    status
    user {
      ...PendingAllyUserFragment
    }
    username
  }
}
Response
{
  "data": {
    "pendingAllyRequests": [
      {
        "accountabilityPartner": false,
        "accountabilityPartnerSince": ISO8601DateTime,
        "checkedInToday": false,
        "createdAtTime": "xyz789",
        "firstName": "abc123",
        "id": 4,
        "lastName": "abc123",
        "mutualCount": 987,
        "mutualStreakCount": 987,
        "partnerRequestedByMe": false,
        "partnerStatus": "abc123",
        "photo": UserPhoto,
        "publicId": "abc123",
        "status": "abc123",
        "user": PendingAllyUser,
        "username": "xyz789"
      }
    ]
  }
}

pendingArtifacts

Description

Admin only. Artifacts awaiting review, cursor-paginated.

Response

Returns an AiArtifactConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
employeeId - ID
first - Int Returns the first n elements from the list.
kind - String
last - Int Returns the last n elements from the list.

Example

Query
query pendingArtifacts(
  $after: String,
  $before: String,
  $employeeId: ID,
  $first: Int,
  $kind: String,
  $last: Int
) {
  pendingArtifacts(
    after: $after,
    before: $before,
    employeeId: $employeeId,
    first: $first,
    kind: $kind,
    last: $last
  ) {
    edges {
      ...AiArtifactEdgeFragment
    }
    nodes {
      ...AiArtifactFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "employeeId": 4,
  "first": 987,
  "kind": "abc123",
  "last": 123
}
Response
{
  "data": {
    "pendingArtifacts": {
      "edges": [AiArtifactEdge],
      "nodes": [AiArtifact],
      "pageInfo": PageInfo
    }
  }
}

pendingChallengeCelebration

Description

The viewer's oldest completed-and-unseen challenge celebration, or null if none is pending.

Response

Returns a ChallengeParticipant

Example

Query
query pendingChallengeCelebration {
  pendingChallengeCelebration {
    communityChallenge {
      ...CommunityChallengeFragment
    }
    completed
    completedAt
    progressCount
    progressPercent
    publicId
    rank
    user {
      ...UserFragment
    }
    userPublicId
  }
}
Response
{
  "data": {
    "pendingChallengeCelebration": {
      "communityChallenge": CommunityChallenge,
      "completed": true,
      "completedAt": ISO8601DateTime,
      "progressCount": 123,
      "progressPercent": 123.45,
      "publicId": 4,
      "rank": 987,
      "user": User,
      "userPublicId": "xyz789"
    }
  }
}

pendingCounts

Description

Per-queue pending item counts for the admin sidebar, filtered by role. Any admin role; fields the role cannot see are null.

Response

Returns a PendingCounts!

Example

Query
query pendingCounts {
  pendingCounts {
    gdprRequests
    marketingDecisions
    moderationQueue
    reviewQueue
    workforceDecisions
    workforceInbox
  }
}
Response
{
  "data": {
    "pendingCounts": {
      "gdprRequests": 123,
      "marketingDecisions": 987,
      "moderationQueue": 123,
      "reviewQueue": 123,
      "workforceDecisions": 987,
      "workforceInbox": 987
    }
  }
}

pendingEncouragementCelebration

Description

The current user's highest-priority unseen encouragement celebration from the last 7 days (completed > milestone > first > newally), or null. Fetching marks it delivered. Always null while encouragement_takeover_enabled is off. Auth required.

Response

Returns an EncouragementCelebration

Example

Query
query pendingEncouragementCelebration {
  pendingEncouragementCelebration {
    canEncourageBack
    createdAt
    emoji
    giver {
      ...UserFragment
    }
    goalId
    id
    moment
    owner {
      ...UserFragment
    }
    targetTitle
  }
}
Response
{
  "data": {
    "pendingEncouragementCelebration": {
      "canEncourageBack": false,
      "createdAt": ISO8601DateTime,
      "emoji": "abc123",
      "giver": User,
      "goalId": "4",
      "id": "4",
      "moment": "COMPLETED",
      "owner": User,
      "targetTitle": "xyz789"
    }
  }
}

personalAnalyticsActivityHeatmap

Description

Trailing 90-day activity heatmap for the current user. Auth required.

Response

Returns an AnalyticsActivityHeatmap

Example

Query
query personalAnalyticsActivityHeatmap {
  personalAnalyticsActivityHeatmap {
    days {
      ...AnalyticsHeatmapDayFragment
    }
  }
}
Response
{
  "data": {
    "personalAnalyticsActivityHeatmap": {
      "days": [AnalyticsHeatmapDay]
    }
  }
}

personalAnalyticsCompletionByCategory

Description

Completion-by-category series for the current user, month-to-date. Auth required.

Response

Returns an AnalyticsCompletionByCategory

Example

Query
query personalAnalyticsCompletionByCategory {
  personalAnalyticsCompletionByCategory {
    series {
      ...AnalyticsCategoryCompletionFragment
    }
  }
}
Response
{
  "data": {
    "personalAnalyticsCompletionByCategory": {
      "series": [AnalyticsCategoryCompletion]
    }
  }
}

personalAnalyticsMonthInReview

Description

Month-in-review hero card for the current user, month-to-date. Auth required.

Response

Returns an AnalyticsMonthInReview

Example

Query
query personalAnalyticsMonthInReview {
  personalAnalyticsMonthInReview {
    bestCategory {
      ...AnalyticsCategoryCompletionFragment
    }
    bestStreak
    daysActive
    daysInMonth
    goalsDone
    xpEarned
  }
}
Response
{
  "data": {
    "personalAnalyticsMonthInReview": {
      "bestCategory": AnalyticsCategoryCompletion,
      "bestStreak": 123,
      "daysActive": 987,
      "daysInMonth": 987,
      "goalsDone": 123,
      "xpEarned": 123
    }
  }
}

personalAnalyticsStreakHistory

Description

Trailing 26-week streak history for the current user. Auth required.

Response

Returns an AnalyticsStreakHistory

Example

Query
query personalAnalyticsStreakHistory {
  personalAnalyticsStreakHistory {
    currentRun
    points {
      ...AnalyticsStreakPointFragment
    }
  }
}
Response
{
  "data": {
    "personalAnalyticsStreakHistory": {
      "currentRun": 987,
      "points": [AnalyticsStreakPoint]
    }
  }
}

personalAnalyticsXpOverTime

Description

Trailing 26-week cumulative XP for the current user. Auth required.

Response

Returns an AnalyticsXpOverTime

Example

Query
query personalAnalyticsXpOverTime {
  personalAnalyticsXpOverTime {
    points {
      ...AnalyticsXpPointFragment
    }
  }
}
Response
{
  "data": {
    "personalAnalyticsXpOverTime": {
      "points": [AnalyticsXpPoint]
    }
  }
}

pickableFeedbackTags

Description

Returns non-archived feedback tags, ordered by position then name. Any authenticated user — for the feedback create-post picker and board filter.

Response

Returns [FeedbackTag!]!

Example

Query
query pickableFeedbackTags {
  pickableFeedbackTags {
    archived
    createdAt
    description
    id
    name
    position
    postsCount
    slug
  }
}
Response
{
  "data": {
    "pickableFeedbackTags": [
      {
        "archived": false,
        "createdAt": ISO8601DateTime,
        "description": "abc123",
        "id": 4,
        "name": "xyz789",
        "position": 123,
        "postsCount": 987,
        "slug": "abc123"
      }
    ]
  }
}

plans

Description

Returns all active subscription plans (Supporter tiers).

Response

Returns [Plan!]!

Example

Query
query plans {
  plans {
    active
    currency
    interval
    name
    priceCents
    priceDisplay
    publicId
    slug
  }
}
Response
{
  "data": {
    "plans": [
      {
        "active": false,
        "currency": "abc123",
        "interval": "xyz789",
        "name": "abc123",
        "priceCents": 987,
        "priceDisplay": "xyz789",
        "publicId": 4,
        "slug": "abc123"
      }
    ]
  }
}

publicCommunity

Description

Fetches the allow-listed public preview of a public, non-team community by public_id — for a signed-out visitor or non-member opening a shared room link. No authentication required. Returns NOT_FOUND for a private, team-scoped, archived, soft-deleted or demo community — never more than any signed-in caller can already see via community(id:).

Response

Returns a PublicCommunity

Arguments
Name Description
id - ID! public_id of the community to preview.

Example

Query
query publicCommunity($id: ID!) {
  publicCommunity(id: $id) {
    category
    description
    imageUrl
    membersCount
    membersToDiscoverable
    name
    publicId
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "publicCommunity": {
      "category": "abc123",
      "description": "abc123",
      "imageUrl": "abc123",
      "membersCount": 123,
      "membersToDiscoverable": 123,
      "name": "abc123",
      "publicId": "4"
    }
  }
}

publicFeedbackPost

Description

Returns a single public feedback post by public ID. Null when not found, soft-deleted, or the read path is disabled.

Response

Returns a PublicFeedbackPost

Arguments
Name Description
id - ID! Public ID of the feedback post.

Example

Query
query publicFeedbackPost($id: ID!) {
  publicFeedbackPost(id: $id) {
    author {
      ...PublicFeedbackAuthorFragment
    }
    category
    commentCount
    comments {
      ...PublicFeedbackCommentFragment
    }
    createdAt
    description
    id
    shippedAt
    status
    tags {
      ...FeedbackTagFragment
    }
    title
    voteCount
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "publicFeedbackPost": {
      "author": PublicFeedbackAuthor,
      "category": "xyz789",
      "commentCount": 987,
      "comments": [PublicFeedbackComment],
      "createdAt": ISO8601DateTime,
      "description": "xyz789",
      "id": 4,
      "shippedAt": ISO8601DateTime,
      "status": "abc123",
      "tags": [FeedbackTag],
      "title": "xyz789",
      "voteCount": 123
    }
  }
}

publicFeedbackPosts

Description

Public, unauthenticated feedback board listing. Null when the read path is disabled. Rate-limited (30 req/min per IP for anonymous callers; per user when authenticated).

Response

Returns [PublicFeedbackPost!]

Arguments
Name Description
status - String Filter by status (open, planned, in_progress, completed, declined).
tags - [String!] Filter by tag slugs (any-of). Posts carrying any of the given tags are returned.

Example

Query
query publicFeedbackPosts(
  $status: String,
  $tags: [String!]
) {
  publicFeedbackPosts(
    status: $status,
    tags: $tags
  ) {
    author {
      ...PublicFeedbackAuthorFragment
    }
    category
    commentCount
    comments {
      ...PublicFeedbackCommentFragment
    }
    createdAt
    description
    id
    shippedAt
    status
    tags {
      ...FeedbackTagFragment
    }
    title
    voteCount
  }
}
Variables
{
  "status": "abc123",
  "tags": ["xyz789"]
}
Response
{
  "data": {
    "publicFeedbackPosts": [
      {
        "author": PublicFeedbackAuthor,
        "category": "abc123",
        "commentCount": 987,
        "comments": [PublicFeedbackComment],
        "createdAt": ISO8601DateTime,
        "description": "abc123",
        "id": 4,
        "shippedAt": ISO8601DateTime,
        "status": "xyz789",
        "tags": [FeedbackTag],
        "title": "abc123",
        "voteCount": 987
      }
    ]
  }
}

publicGoal

Description

Fetches a publicly visible goal by public_id. Returns an error if the goal is private.

Response

Returns a Goal

Arguments
Name Description
id - ID! public_id of the goal to retrieve.

Example

Query
query publicGoal($id: ID!) {
  publicGoal(id: $id) {
    allEvents {
      ...GoalEventFragment
    }
    appLink
    averageCheckInTime
    calendarMonth {
      ...GoalCalendarMonthFragment
    }
    category {
      ...GoalCategoryFragment
    }
    challenge {
      ...GoalChallengeFragment
    }
    chapters {
      ...GoalChapterFragment
    }
    checkedInToday
    collectiveGoalContribution {
      ...GoalCollectiveContributionFragment
    }
    comments {
      ...GoalEventCommentFragment
    }
    completed
    completedAtTime
    completionRate
    completionReflection
    content
    continuesGoal {
      ...GoalFragment
    }
    createdAtTime
    currentAmount
    dayOfWeekDistribution
    daysToUpdate
    demo
    dueToday
    durationMinutes
    encouragedBy {
      ...EncouragedByFragment
    }
    encouragements {
      ...GoalEventEncouragementFragment
    }
    events {
      ...GoalEventFragment
    }
    followersCount
    fromTemplate {
      ...GoalTemplateFragment
    }
    fromTemplateName
    habitCompletions {
      ...HabitCompletionFragment
    }
    habitStreak
    habitStreakUnit
    identityPrompt
    imageUrl
    journeyRecap {
      ...JourneyRecapFragment
    }
    kind {
      ...GoalTypeFragment
    }
    lastCheckedInDate
    lifeArea
    lockVersion
    longestHabitStreak
    milestones {
      ...GoalFragment
    }
    name
    nonAllyFollowersCount
    parentGoalId
    pastAttemptContext
    position
    practiceWeek {
      ...PracticeWeekFragment
    }
    practices {
      ...GoalFragment
    }
    preBreakHabitStreak
    private
    publicId
    quickUpdatePrompts
    recurrenceDays
    recurrenceInterval
    recurrenceType
    sharedWithPartner
    status
    streakFreezesAvailable
    streakFreezesUsed
    streakRepairEligibleUntil
    streakRepairedCount
    successorGoal {
      ...GoalFragment
    }
    successorOffer {
      ...SuccessorOfferFragment
    }
    supportsGoal {
      ...GoalFragment
    }
    targetAmount
    targetDateTime
    totalCheckIns
    unit
    updatedAtTime
    user {
      ...UserFragment
    }
    viewerCheeredToday
    visibility
    weeklyTarget
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "publicGoal": {
      "allEvents": [GoalEvent],
      "appLink": "xyz789",
      "averageCheckInTime": 987.65,
      "calendarMonth": GoalCalendarMonth,
      "category": GoalCategory,
      "challenge": GoalChallenge,
      "chapters": [GoalChapter],
      "checkedInToday": false,
      "collectiveGoalContribution": GoalCollectiveContribution,
      "comments": [GoalEventComment],
      "completed": false,
      "completedAtTime": "abc123",
      "completionRate": 987.65,
      "completionReflection": "xyz789",
      "content": "xyz789",
      "continuesGoal": Goal,
      "createdAtTime": "xyz789",
      "currentAmount": 123.45,
      "dayOfWeekDistribution": [987],
      "daysToUpdate": 987,
      "demo": true,
      "dueToday": false,
      "durationMinutes": 123,
      "encouragedBy": EncouragedBy,
      "encouragements": [GoalEventEncouragement],
      "events": [GoalEvent],
      "followersCount": 987,
      "fromTemplate": GoalTemplate,
      "fromTemplateName": "xyz789",
      "habitCompletions": [HabitCompletion],
      "habitStreak": 123,
      "habitStreakUnit": "DAY",
      "identityPrompt": "xyz789",
      "imageUrl": "abc123",
      "journeyRecap": JourneyRecap,
      "kind": GoalType,
      "lastCheckedInDate": "abc123",
      "lifeArea": "xyz789",
      "lockVersion": 987,
      "longestHabitStreak": 123,
      "milestones": [Goal],
      "name": "abc123",
      "nonAllyFollowersCount": 123,
      "parentGoalId": "abc123",
      "pastAttemptContext": "abc123",
      "position": 987,
      "practiceWeek": PracticeWeek,
      "practices": [Goal],
      "preBreakHabitStreak": 123,
      "private": false,
      "publicId": "4",
      "quickUpdatePrompts": ["abc123"],
      "recurrenceDays": ["xyz789"],
      "recurrenceInterval": 987,
      "recurrenceType": "abc123",
      "sharedWithPartner": true,
      "status": "completed",
      "streakFreezesAvailable": 123,
      "streakFreezesUsed": 987,
      "streakRepairEligibleUntil": "xyz789",
      "streakRepairedCount": 123,
      "successorGoal": Goal,
      "successorOffer": SuccessorOffer,
      "supportsGoal": Goal,
      "targetAmount": 123.45,
      "targetDateTime": "abc123",
      "totalCheckIns": 987,
      "unit": "abc123",
      "updatedAtTime": "abc123",
      "user": User,
      "viewerCheeredToday": false,
      "visibility": "ALLIES",
      "weeklyTarget": 123
    }
  }
}

recentArtifacts

Description

Admin only. Recently processed (approved/rejected/delivered) artifacts from the last 7 days, cursor-paginated.

Response

Returns an AiArtifactConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
employeeId - ID
first - Int Returns the first n elements from the list.
kind - String
last - Int Returns the last n elements from the list.

Example

Query
query recentArtifacts(
  $after: String,
  $before: String,
  $employeeId: ID,
  $first: Int,
  $kind: String,
  $last: Int
) {
  recentArtifacts(
    after: $after,
    before: $before,
    employeeId: $employeeId,
    first: $first,
    kind: $kind,
    last: $last
  ) {
    edges {
      ...AiArtifactEdgeFragment
    }
    nodes {
      ...AiArtifactFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "employeeId": 4,
  "first": 123,
  "kind": "xyz789",
  "last": 987
}
Response
{
  "data": {
    "recentArtifacts": {
      "edges": [AiArtifactEdge],
      "nodes": [AiArtifact],
      "pageInfo": PageInfo
    }
  }
}

recommendedCommunities

Description

Returns communities recommended for a user based on their goal interests.

Response

Returns [SuggestedCommunity!]

Arguments
Name Description
limit - Int Maximum number of recommendations to return. Defaults to 5.
userId - ID! public_id of the user to generate recommendations for.

Example

Query
query recommendedCommunities(
  $limit: Int,
  $userId: ID!
) {
  recommendedCommunities(
    limit: $limit,
    userId: $userId
  ) {
    activeMembers
    category
    coverImage
    description
    isRecommended
    matchScore
    members {
      ...DiscoveryMemberFragment
    }
    mutualAllies
    name
    publicId
    reason {
      ...CommunityReasonFragment
    }
  }
}
Variables
{"limit": 987, "userId": "4"}
Response
{
  "data": {
    "recommendedCommunities": [
      {
        "activeMembers": 987,
        "category": "abc123",
        "coverImage": "xyz789",
        "description": "abc123",
        "isRecommended": false,
        "matchScore": 987,
        "members": [DiscoveryMember],
        "mutualAllies": 123,
        "name": "xyz789",
        "publicId": 4,
        "reason": CommunityReason
      }
    ]
  }
}

reminderNotificationPreferences

Description

Returns the progress-nudge reminder notification preferences for the authenticated user.

Example

Query
query reminderNotificationPreferences {
  reminderNotificationPreferences {
    enabled
    whyLineEnabled
  }
}
Response
{
  "data": {
    "reminderNotificationPreferences": {
      "enabled": true,
      "whyLineEnabled": false
    }
  }
}

searchUsers

Description

Auth-gated user search by username or email; pg_trgm-backed; rate-limited 10/min/user. Returns per-result allyStatus enrichment. Excludes the searching user and users who have blocked them.

Response

Returns a UserSearchResultConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.
query - String! Search query, minimum 2 characters.

Example

Query
query searchUsers(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $query: String!
) {
  searchUsers(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    query: $query
  ) {
    edges {
      ...UserSearchResultEdgeFragment
    }
    nodes {
      ...UserSearchResultFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 123,
  "query": "abc123"
}
Response
{
  "data": {
    "searchUsers": {
      "edges": [UserSearchResultEdge],
      "nodes": [UserSearchResult],
      "pageInfo": PageInfo
    }
  }
}

seasonalEvent

Description

Fetches a seasonal event by its public_id, regardless of status or is_active. Nil (never a GraphQL error) for an unknown id or a soft-deleted event.

Response

Returns a SeasonalEvent

Arguments
Name Description
id - ID! public_id of the seasonal event to retrieve.

Example

Query
query seasonalEvent($id: ID!) {
  seasonalEvent(id: $id) {
    badgeIcon
    badgeName
    createdAtTime
    currentUserParticipant {
      ...SeasonalEventParticipantFragment
    }
    description
    endDate
    isActive
    isParticipating
    name
    participantCount
    publicId
    slug
    startDate
    status
    targetGoalCount
    updatedAtTime
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "seasonalEvent": {
      "badgeIcon": "abc123",
      "badgeName": "xyz789",
      "createdAtTime": "abc123",
      "currentUserParticipant": SeasonalEventParticipant,
      "description": "abc123",
      "endDate": ISO8601Date,
      "isActive": true,
      "isParticipating": false,
      "name": "abc123",
      "participantCount": 123,
      "publicId": 4,
      "slug": "xyz789",
      "startDate": ISO8601Date,
      "status": "xyz789",
      "targetGoalCount": 123,
      "updatedAtTime": "abc123"
    }
  }
}

seasonalEvents

Description

Returns all seasonal events, newest first. Admin only.

Response

Returns [SeasonalEvent!]

Example

Query
query seasonalEvents {
  seasonalEvents {
    badgeIcon
    badgeName
    createdAtTime
    currentUserParticipant {
      ...SeasonalEventParticipantFragment
    }
    description
    endDate
    isActive
    isParticipating
    name
    participantCount
    publicId
    slug
    startDate
    status
    targetGoalCount
    updatedAtTime
  }
}
Response
{
  "data": {
    "seasonalEvents": [
      {
        "badgeIcon": "abc123",
        "badgeName": "xyz789",
        "createdAtTime": "abc123",
        "currentUserParticipant": SeasonalEventParticipant,
        "description": "abc123",
        "endDate": ISO8601Date,
        "isActive": false,
        "isParticipating": true,
        "name": "xyz789",
        "participantCount": 987,
        "publicId": "4",
        "slug": "xyz789",
        "startDate": ISO8601Date,
        "status": "xyz789",
        "targetGoalCount": 987,
        "updatedAtTime": "xyz789"
      }
    ]
  }
}

shareableMoment

Description

Server-authored share-card facts for a celebration the caller owns and has earned. Auth required. Returns null for a not-found, unowned, or not-yet-earned subject.

Response

Returns a ShareableMoment

Arguments
Name Description
kind - String! One of: badge, goal_completion, milestone, streak.
subjectPublicId - ID! public_id of the subject (badge key for kind: badge; the caller's own public_id for kind: streak).

Example

Query
query shareableMoment(
  $kind: String!,
  $subjectPublicId: ID!
) {
  shareableMoment(
    kind: $kind,
    subjectPublicId: $subjectPublicId
  ) {
    badgeIconUrl
    badgeName
    checkInCount
    daysTaken
    displayName
    earnedOn
    encouragerCount
    firstCheckInExcerpt
    firstCheckInOn
    goalTitle
    kind
    lastCheckInExcerpt
    lastCheckInOn
    milestoneIndex
    milestoneTitle
    milestoneTotal
    shareCode
    streakAtFinish
    streakDays
    supporterMark
    username
  }
}
Variables
{"kind": "xyz789", "subjectPublicId": 4}
Response
{
  "data": {
    "shareableMoment": {
      "badgeIconUrl": "xyz789",
      "badgeName": "abc123",
      "checkInCount": 987,
      "daysTaken": 987,
      "displayName": "abc123",
      "earnedOn": ISO8601Date,
      "encouragerCount": 123,
      "firstCheckInExcerpt": "abc123",
      "firstCheckInOn": ISO8601Date,
      "goalTitle": "xyz789",
      "kind": "abc123",
      "lastCheckInExcerpt": "xyz789",
      "lastCheckInOn": ISO8601Date,
      "milestoneIndex": 123,
      "milestoneTitle": "xyz789",
      "milestoneTotal": 987,
      "shareCode": "xyz789",
      "streakAtFinish": 987,
      "streakDays": 987,
      "supporterMark": "abc123",
      "username": "abc123"
    }
  }
}

suggestedAllies

Description

Returns suggested ally candidates ranked by shared community overlap. Auth required.

Response

Returns [AllySuggestion!]!

Arguments
Name Description
limit - Int Maximum number of suggestions to return. Defaults to 10, capped at 25.

Example

Query
query suggestedAllies($limit: Int) {
  suggestedAllies(limit: $limit) {
    allyStatus
    firstName
    lastName
    mutualCount
    photo {
      ...UserPhotoFragment
    }
    publicId
    reason
    username
  }
}
Variables
{"limit": 987}
Response
{
  "data": {
    "suggestedAllies": [
      {
        "allyStatus": "ACCEPTED",
        "firstName": "xyz789",
        "lastName": "xyz789",
        "mutualCount": 123,
        "photo": UserPhoto,
        "publicId": "abc123",
        "reason": "abc123",
        "username": "abc123"
      }
    ]
  }
}

systemHealth

Description

Admin-only self-health probes for infra + identity.

Response

Returns a SystemHealth!

Example

Query
query systemHealth {
  systemHealth {
    agentRunnerReachable
    currentAdminPublicId
    currentAdminRoleList
    databaseReachable
    deployRevision
    deployTimestamp
    litellmReachable
    redisReachable
    sidekiqReachable
  }
}
Response
{
  "data": {
    "systemHealth": {
      "agentRunnerReachable": false,
      "currentAdminPublicId": "xyz789",
      "currentAdminRoleList": ["xyz789"],
      "databaseReachable": true,
      "deployRevision": "xyz789",
      "deployTimestamp": "xyz789",
      "litellmReachable": true,
      "redisReachable": false,
      "sidekiqReachable": true
    }
  }
}

teamHome

Description

Aggregate read backing TeamHomeView (N13). Null when the team does not exist, or the caller is not a member (PRIVACY-2).

Response

Returns a TeamHome

Arguments
Name Description
teamId - String!

Example

Query
query teamHome($teamId: String!) {
  teamHome(teamId: $teamId) {
    activeRoomId
    billingState
    collectiveGoal {
      ...CollectiveGoalFragment
    }
    collectiveGoalPrivacyContractAcknowledged
    feed {
      ...TeamFeedItemFragment
    }
    isFreshMember
    role
    rooms {
      ...CommunityFragment
    }
    team {
      ...TeamFragment
    }
    trialDaysLeft
  }
}
Variables
{"teamId": "abc123"}
Response
{
  "data": {
    "teamHome": {
      "activeRoomId": 4,
      "billingState": "abc123",
      "collectiveGoal": CollectiveGoal,
      "collectiveGoalPrivacyContractAcknowledged": true,
      "feed": [TeamFeedItem],
      "isFreshMember": false,
      "role": "abc123",
      "rooms": [Community],
      "team": Team,
      "trialDaysLeft": 987
    }
  }
}

teamInsight

Description

Team-period aggregates for owners and admins (Team Insight). Null when the team does not exist, the caller lacks manage_team, or the period is invalid.

Response

Returns a TeamInsight

Arguments
Name Description
period - String! weekly, monthly, or all_time.
teamId - String!

Example

Query
query teamInsight(
  $period: String!,
  $teamId: String!
) {
  teamInsight(
    period: $period,
    teamId: $teamId
  ) {
    activeMembers
    boardMemberCount
    checkinTrend {
      ...TeamInsightTrendPointFragment
    }
    collectiveGoals {
      ...TeamInsightGoalFragment
    }
    inactiveMembers
    period
    rooms {
      ...TeamInsightRoomFragment
    }
    teamCheckins
    teamPoints
    totalMembers
  }
}
Variables
{
  "period": "abc123",
  "teamId": "abc123"
}
Response
{
  "data": {
    "teamInsight": {
      "activeMembers": 123,
      "boardMemberCount": 987,
      "checkinTrend": [TeamInsightTrendPoint],
      "collectiveGoals": [TeamInsightGoal],
      "inactiveMembers": 123,
      "period": "abc123",
      "rooms": [TeamInsightRoom],
      "teamCheckins": 123,
      "teamPoints": 123,
      "totalMembers": 123
    }
  }
}

teamInvitePreview

Description

Public preview of a team invite by code — team name, inviter first name, and member count. No auth required. Never distinguishes expired/revoked/exhausted from each other ("unavailable"), only from a code that never existed ("not_found"). Rate-limited (60 req/min per IP for anonymous callers; per user when authenticated).

Response

Returns a TeamInvitePreview!

Arguments
Name Description
code - String! Invite code from the /join-team/{code} URL.

Example

Query
query teamInvitePreview($code: String!) {
  teamInvitePreview(code: $code) {
    inviterName
    memberCount
    status
    teamName
  }
}
Variables
{"code": "abc123"}
Response
{
  "data": {
    "teamInvitePreview": {
      "inviterName": "xyz789",
      "memberCount": 123,
      "status": "xyz789",
      "teamName": "xyz789"
    }
  }
}

teamLeaderboard

Description

Aggregate read backing TeamLeaderboardView (N19). Null when the team/community does not exist, or the caller is not a member (PRIVACY-2).

Response

Returns a TeamLeaderboard

Arguments
Name Description
communityId - String Scopes to a sub-community leaderboard. Omit for the team-wide leaderboard.
period - String! weekly, monthly, or all_time.
teamId - String!

Example

Query
query teamLeaderboard(
  $communityId: String,
  $period: String!,
  $teamId: String!
) {
  teamLeaderboard(
    communityId: $communityId,
    period: $period,
    teamId: $teamId
  ) {
    entries {
      ...TeamLeaderboardEntryFragment
    }
    period
    rooms {
      ...CommunityFragment
    }
    team {
      ...TeamFragment
    }
    yourMembershipOptedOut
  }
}
Variables
{
  "communityId": "xyz789",
  "period": "xyz789",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "teamLeaderboard": {
      "entries": [TeamLeaderboardEntry],
      "period": "abc123",
      "rooms": [Community],
      "team": Team,
      "yourMembershipOptedOut": true
    }
  }
}

teamLeaderboardOptOutStats

Description

Admin-only. Raw per-team leaderboard opt-out counts (LEADERBOARD-5 anti-metric monitoring).

Response

Returns [TeamLeaderboardOptOutStat!]

Example

Query
query teamLeaderboardOptOutStats {
  teamLeaderboardOptOutStats {
    memberCount
    optedOutCount
    teamName
  }
}
Response
{
  "data": {
    "teamLeaderboardOptOutStats": [
      {
        "memberCount": 987,
        "optedOutCount": 987,
        "teamName": "abc123"
      }
    ]
  }
}

teamMemberActivity

Description

Read-only team-scoped activity summary for one member (N7b "View activity"). Null when the team or member does not exist, the member is not seated on the team, or the caller lacks manage_team (owner/admin only).

Response

Returns a TeamMemberActivity

Arguments
Name Description
memberId - String! The target member's User public_id.
teamId - String!

Example

Query
query teamMemberActivity(
  $memberId: String!,
  $teamId: String!
) {
  teamMemberActivity(
    memberId: $memberId,
    teamId: $teamId
  ) {
    collectiveGoalContributions
    lastActiveDays
    lastActiveLabel
    optedOut
    periodStats {
      ...TeamMemberActivityPeriodStatFragment
    }
    subCommunityNames
  }
}
Variables
{
  "memberId": "abc123",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "teamMemberActivity": {
      "collectiveGoalContributions": 123,
      "lastActiveDays": 987,
      "lastActiveLabel": "abc123",
      "optedOut": false,
      "periodStats": [TeamMemberActivityPeriodStat],
      "subCommunityNames": ["abc123"]
    }
  }
}

teamMemberRoster

Description

Manager View roster: one row per team member with identity and the same activity summary as teamMemberActivity, batched. Null when the team does not exist, or the caller lacks manage_team (owner/admin only).

Response

Returns [TeamMemberRosterRow!]

Arguments
Name Description
teamId - String!

Example

Query
query teamMemberRoster($teamId: String!) {
  teamMemberRoster(teamId: $teamId) {
    activity {
      ...TeamMemberActivityFragment
    }
    member {
      ...TeamMemberSummaryFragment
    }
  }
}
Variables
{"teamId": "abc123"}
Response
{
  "data": {
    "teamMemberRoster": [
      {
        "activity": TeamMemberActivity,
        "member": TeamMemberSummary
      }
    ]
  }
}

teamNotificationPreferences

Description

Returns the team notification preferences for the authenticated user.

Response

Returns a TeamNotificationPreferences!

Example

Query
query teamNotificationPreferences {
  teamNotificationPreferences {
    enabled
  }
}
Response
{"data": {"teamNotificationPreferences": {"enabled": true}}}

teamPlans

Description

Returns all active Team subscription plans (Teams Monthly, Teams Annual).

Response

Returns [Plan!]!

Example

Query
query teamPlans {
  teamPlans {
    active
    currency
    interval
    name
    priceCents
    priceDisplay
    publicId
    slug
  }
}
Response
{
  "data": {
    "teamPlans": [
      {
        "active": true,
        "currency": "xyz789",
        "interval": "abc123",
        "name": "xyz789",
        "priceCents": 987,
        "priceDisplay": "abc123",
        "publicId": 4,
        "slug": "abc123"
      }
    ]
  }
}

teamPulseEligibility

Description

Whether the viewer should be prompted for this quarter's pulse survey. Null when the team does not exist, or the caller is not a member (PRIVACY-2).

Response

Returns a Boolean

Arguments
Name Description
teamId - String!

Example

Query
query teamPulseEligibility($teamId: String!) {
  teamPulseEligibility(teamId: $teamId)
}
Variables
{"teamId": "xyz789"}
Response
{"data": {"teamPulseEligibility": false}}

teamSettings

Description

Aggregate read backing Team Settings (N7). Null when the team does not exist, or the caller is not a member (PRIVACY-2).

Response

Returns a TeamSettings

Arguments
Name Description
teamId - String!

Example

Query
query teamSettings($teamId: String!) {
  teamSettings(teamId: $teamId) {
    maxSubCommunities
    members {
      ...TeamMemberSummaryFragment
    }
    pendingInvites {
      ...TeamPendingInviteFragment
    }
    role
    seatLimit
    seatsUsed
    subCommunities {
      ...CommunityFragment
    }
    team {
      ...TeamFragment
    }
  }
}
Variables
{"teamId": "abc123"}
Response
{
  "data": {
    "teamSettings": {
      "maxSubCommunities": 987,
      "members": [TeamMemberSummary],
      "pendingInvites": [TeamPendingInvite],
      "role": "abc123",
      "seatLimit": 123,
      "seatsUsed": 987,
      "subCommunities": [Community],
      "team": Team
    }
  }
}

tourFunnelStats

Description

Tour-completion funnel aggregates per tour id. Admin only.

Response

Returns [TourFunnel!]

Arguments
Name Description
periodSeconds - Int Window in seconds, scoped by user signup date (default 30 days = 2,592,000).

Example

Query
query tourFunnelStats($periodSeconds: Int) {
  tourFunnelStats(periodSeconds: $periodSeconds) {
    completed
    completionRate
    dismissed
    started
    tourId
  }
}
Variables
{"periodSeconds": 987}
Response
{
  "data": {
    "tourFunnelStats": [
      {
        "completed": 123,
        "completionRate": 987.65,
        "dismissed": 123,
        "started": 123,
        "tourId": "abc123"
      }
    ]
  }
}

trendingCommunities

Description

Returns communities with the highest recent growth or activity.

Response

Returns [TrendingCommunity!]

Arguments
Name Description
limit - Int Maximum number of trending communities to return. Defaults to 5.

Example

Query
query trendingCommunities($limit: Int) {
  trendingCommunities(limit: $limit) {
    activeMembers
    category
    coverImage
    description
    growthRate
    isTrending
    name
    publicId
    reason {
      ...CommunityReasonFragment
    }
    totalGoals
    totalMembers
  }
}
Variables
{"limit": 123}
Response
{
  "data": {
    "trendingCommunities": [
      {
        "activeMembers": 987,
        "category": "xyz789",
        "coverImage": "abc123",
        "description": "xyz789",
        "growthRate": 987.65,
        "isTrending": true,
        "name": "xyz789",
        "publicId": 4,
        "reason": CommunityReason,
        "totalGoals": 123,
        "totalMembers": 123
      }
    ]
  }
}

unifiedFeed

Description

Returns a paginated unified activity feed combining ally activity, community posts, notifications, and own progress.

Response

Returns a UnifiedFeed

Arguments
Name Description
cheerable - Boolean When true, returns only goal events from allies and joined communities that the viewer has not cheered yet — never the viewer's own events or community posts. limit is clamped to 5.
limit - Int Number of feed items per page. Defaults to 20.
offset - Int Number of items to skip for pagination. Defaults to 0.

Example

Query
query unifiedFeed(
  $cheerable: Boolean,
  $limit: Int,
  $offset: Int
) {
  unifiedFeed(
    cheerable: $cheerable,
    limit: $limit,
    offset: $offset
  ) {
    allyBadges {
      ...FeedAllyBadgeFragment
    }
    hasMore
    items {
      ...UnifiedFeedItemFragment
    }
    totalCount
  }
}
Variables
{"cheerable": true, "limit": 123, "offset": 987}
Response
{
  "data": {
    "unifiedFeed": {
      "allyBadges": [FeedAllyBadge],
      "hasMore": true,
      "items": [UnifiedFeedItem],
      "totalCount": 987
    }
  }
}

user

Description

Fetches a user by public_id. Requires authentication; admins can fetch any user.

Response

Returns a User

Arguments
Name Description
id - ID! public_id of the user to retrieve.

Example

Query
query user($id: ID!) {
  user(id: $id) {
    achievementStats {
      ...AchievementStatsFragment
    }
    actions {
      ...UserActionFragment
    }
    admin
    adminRoles
    badgeActions {
      ...UserActionFragment
    }
    celebrationPreferences {
      ...CelebrationPreferencesFragment
    }
    charterMarkerHidden
    charterMemberSince
    charterNotesEnabled
    coachingPreferences {
      ...CoachingPreferencesFragment
    }
    colorTheme
    completedCommunityChallenges {
      ...ChallengeParticipantFragment
    }
    completedSeasonalEvents {
      ...SeasonalEventParticipantFragment
    }
    createdAtTime
    currentInsights {
      ...InsightPackFragment
    }
    dashboardPreferences {
      ...DashboardPreferencesFragment
    }
    dayClosedToday
    daysShownUp
    daysSinceLastActive
    demo
    details {
      ...UserDetailFragment
    }
    email
    emailVerified
    featureTourStatus
    feedItems {
      ...UserFeedItemFragment
    }
    firstName
    goItAlone
    goalDayContext {
      ...GoalDayContextFragment
    }
    goalDayLog {
      ...GoalDayLogEntryFragment
    }
    goalDaySummaries {
      ...GoalDaySummaryFragment
    }
    goalMotivationProfile {
      ...GoalMotivationProfileFragment
    }
    goals {
      ...GoalFragment
    }
    graceDays
    hasAlly
    hasCreatedFromTemplate
    hasDigestEnabled
    isSupporter
    lastDigestSentAt
    lastName
    latestEnneagramAssessment {
      ...EnneagramAssessmentFragment
    }
    level
    longestStreak
    moodGoalInsight {
      ...InsightPackFragment
    }
    nextLevelThreshold
    nextOnTheShelfBadge {
      ...NextBadgeFragment
    }
    notifications {
      ...UserNotificationFragment
    }
    onboardingStatus {
      ...OnboardingStatusFragment
    }
    paceSuggestion {
      ...PaceSuggestionFragment
    }
    photo {
      ...UserPhotoFragment
    }
    practiceInviteDismissedAt
    privateMode
    progressToNextLevel
    publicId
    recentlyUnlockedBadges {
      ...RecentlyUnlockedBadgeFragment
    }
    requiredCheckinsCompleteToday
    reverseNudge {
      ...ReverseNudgeFragment
    }
    showcasedAchievements
    signInDates
    signupAgeDays
    stats {
      ...UserStatsFragment
    }
    streak
    streakJourney {
      ...StreakJourneyFragment
    }
    streakRecountNotePending
    streakRepairOffer {
      ...StreakRepairOfferFragment
    }
    streakRescueDays {
      ...StreakRescueDayFragment
    }
    supporterCancelAtPeriodEnd
    supporterMoments {
      ...SupporterMomentsFragment
    }
    supporterTier
    supporterUntil
    timeToFirstGoalSeconds
    todaysMood
    unlockedAchievementKeys
    updatedAtTime
    username
    welcomeBackOffer {
      ...WelcomeBackOfferFragment
    }
    xp
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "user": {
      "achievementStats": AchievementStats,
      "actions": [UserAction],
      "admin": false,
      "adminRoles": ["xyz789"],
      "badgeActions": [UserAction],
      "celebrationPreferences": CelebrationPreferences,
      "charterMarkerHidden": false,
      "charterMemberSince": ISO8601DateTime,
      "charterNotesEnabled": true,
      "coachingPreferences": CoachingPreferences,
      "colorTheme": "xyz789",
      "completedCommunityChallenges": [
        ChallengeParticipant
      ],
      "completedSeasonalEvents": [
        SeasonalEventParticipant
      ],
      "createdAtTime": "abc123",
      "currentInsights": [InsightPack],
      "dashboardPreferences": DashboardPreferences,
      "dayClosedToday": true,
      "daysShownUp": 987,
      "daysSinceLastActive": 987,
      "demo": false,
      "details": UserDetail,
      "email": "abc123",
      "emailVerified": false,
      "featureTourStatus": {},
      "feedItems": [UserFeedItem],
      "firstName": "abc123",
      "goItAlone": false,
      "goalDayContext": GoalDayContext,
      "goalDayLog": [GoalDayLogEntry],
      "goalDaySummaries": [GoalDaySummary],
      "goalMotivationProfile": GoalMotivationProfile,
      "goals": [Goal],
      "graceDays": ["abc123"],
      "hasAlly": false,
      "hasCreatedFromTemplate": true,
      "hasDigestEnabled": true,
      "isSupporter": false,
      "lastDigestSentAt": "abc123",
      "lastName": "abc123",
      "latestEnneagramAssessment": EnneagramAssessment,
      "level": 987,
      "longestStreak": 123,
      "moodGoalInsight": InsightPack,
      "nextLevelThreshold": 987,
      "nextOnTheShelfBadge": NextBadge,
      "notifications": [UserNotification],
      "onboardingStatus": OnboardingStatus,
      "paceSuggestion": PaceSuggestion,
      "photo": UserPhoto,
      "practiceInviteDismissedAt": "abc123",
      "privateMode": false,
      "progressToNextLevel": 987.65,
      "publicId": 4,
      "recentlyUnlockedBadges": [RecentlyUnlockedBadge],
      "requiredCheckinsCompleteToday": true,
      "reverseNudge": ReverseNudge,
      "showcasedAchievements": ["abc123"],
      "signInDates": ["xyz789"],
      "signupAgeDays": 987,
      "stats": UserStats,
      "streak": 987,
      "streakJourney": StreakJourney,
      "streakRecountNotePending": true,
      "streakRepairOffer": StreakRepairOffer,
      "streakRescueDays": [StreakRescueDay],
      "supporterCancelAtPeriodEnd": true,
      "supporterMoments": SupporterMoments,
      "supporterTier": "xyz789",
      "supporterUntil": ISO8601DateTime,
      "timeToFirstGoalSeconds": 987,
      "todaysMood": "xyz789",
      "unlockedAchievementKeys": ["xyz789"],
      "updatedAtTime": "abc123",
      "username": "abc123",
      "welcomeBackOffer": WelcomeBackOffer,
      "xp": 987
    }
  }
}

userAllies

Description

Returns a user's accepted ally (friend) connections.

Response

Returns [UserAlly!]

Arguments
Name Description
userId - ID! public_id of the user whose allies to retrieve.

Example

Query
query userAllies($userId: ID!) {
  userAllies(userId: $userId) {
    accountabilityPartner
    accountabilityPartnerSince
    checkedInToday
    createdAtTime
    firstName
    id
    lastName
    mutualCount
    mutualStreakCount
    partnerRequestedByMe
    partnerStatus
    photo {
      ...UserPhotoFragment
    }
    publicId
    status
    user {
      ...PendingAllyUserFragment
    }
    username
  }
}
Variables
{"userId": 4}
Response
{
  "data": {
    "userAllies": [
      {
        "accountabilityPartner": false,
        "accountabilityPartnerSince": ISO8601DateTime,
        "checkedInToday": false,
        "createdAtTime": "xyz789",
        "firstName": "xyz789",
        "id": 4,
        "lastName": "xyz789",
        "mutualCount": 123,
        "mutualStreakCount": 987,
        "partnerRequestedByMe": false,
        "partnerStatus": "xyz789",
        "photo": UserPhoto,
        "publicId": "xyz789",
        "status": "xyz789",
        "user": PendingAllyUser,
        "username": "abc123"
      }
    ]
  }
}

userByUsername

Description

Looks up a user by username and returns their public profile (public-safe fields only). Public; no authentication required. Rate-limited to 30/min per signed-in user, or per request IP for anonymous callers. Returns nil for not-found, soft-deleted, or blank usernames.

Response

Returns a PublicProfile

Arguments
Name Description
username - String! Username (handle) to look up. Case-insensitive.

Example

Query
query userByUsername($username: String!) {
  userByUsername(username: $username) {
    achievementStats {
      ...AchievementStatsFragment
    }
    alliesCount
    allyGoals {
      ...PublicGoalFragment
    }
    allyStatus
    canEncourage
    firstName
    goItAlone
    lastName
    level
    longestStreak
    nextLevelThreshold
    nextOnTheShelfBadge {
      ...NextBadgeFragment
    }
    partnerGoals {
      ...PublicGoalFragment
    }
    photo {
      ...UserPhotoFragment
    }
    progressToNextLevel
    publicGoals {
      ...PublicGoalFragment
    }
    publicId
    showcasedAchievements
    signInDates
    signupAgeDays
    streak
    unlockedBadges {
      ...RecentlyUnlockedBadgeFragment
    }
    username
    viewerCheeredToday
    viewerIsAccountabilityPartner
    xp
  }
}
Variables
{"username": "abc123"}
Response
{
  "data": {
    "userByUsername": {
      "achievementStats": AchievementStats,
      "alliesCount": 987,
      "allyGoals": [PublicGoal],
      "allyStatus": "xyz789",
      "canEncourage": true,
      "firstName": "abc123",
      "goItAlone": true,
      "lastName": "xyz789",
      "level": 123,
      "longestStreak": 987,
      "nextLevelThreshold": 123,
      "nextOnTheShelfBadge": NextBadge,
      "partnerGoals": [PublicGoal],
      "photo": UserPhoto,
      "progressToNextLevel": 987.65,
      "publicGoals": [PublicGoal],
      "publicId": "4",
      "showcasedAchievements": ["abc123"],
      "signInDates": ["xyz789"],
      "signupAgeDays": 987,
      "streak": 123,
      "unlockedBadges": [RecentlyUnlockedBadge],
      "username": "xyz789",
      "viewerCheeredToday": true,
      "viewerIsAccountabilityPartner": false,
      "xp": 123
    }
  }
}

users

Description

Admin only. Cursor-paginated user list, created_at DESC.

Response

Returns a UserConnection!

Arguments
Name Description
after - String Returns the elements in the list that come after the specified cursor.
before - String Returns the elements in the list that come before the specified cursor.
first - Int Returns the first n elements from the list.
last - Int Returns the last n elements from the list.

Example

Query
query users(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  users(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edges {
      ...UserEdgeFragment
    }
    nodes {
      ...UserFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987
}
Response
{
  "data": {
    "users": {
      "edges": [UserEdge],
      "nodes": [User],
      "pageInfo": PageInfo
    }
  }
}

weeklyDigestPreferences

Description

Returns the weekly digest email preferences for the authenticated user.

Response

Returns a WeeklyDigestPreferences!

Example

Query
query weeklyDigestPreferences {
  weeklyDigestPreferences {
    deliveryDay
    enabled
  }
}
Response
{
  "data": {
    "weeklyDigestPreferences": {
      "deliveryDay": "xyz789",
      "enabled": true
    }
  }
}

welcomeSeriesPreferences

Description

Returns the welcome series email preferences for the authenticated user.

Response

Returns a WelcomeSeriesPreferences!

Example

Query
query welcomeSeriesPreferences {
  welcomeSeriesPreferences {
    enabled
  }
}
Response
{"data": {"welcomeSeriesPreferences": {"enabled": false}}}

wordCloud

Description

Generates word frequency data from a model column for admin analytics. Admin or marketing role.

Response

Returns [WordCloud!]

Arguments
Name Description
column - String! Column name to analyze for word frequency (e.g. "name").
model - String! ActiveRecord model name to query (e.g. "Goal").

Example

Query
query wordCloud(
  $column: String!,
  $model: String!
) {
  wordCloud(
    column: $column,
    model: $model
  ) {
    name
    value
  }
}
Variables
{
  "column": "abc123",
  "model": "xyz789"
}
Response
{
  "data": {
    "wordCloud": [
      {"name": "xyz789", "value": 123}
    ]
  }
}

Mutations

acceptAiAutonomyOffer

Description

The one tap: turns on the offer's target autonomy level for this (agent, kind). Idempotent.

Response

Returns an AcceptAiAutonomyOfferPayload!

Arguments
Name Description
id - String!

Example

Query
mutation acceptAiAutonomyOffer($id: String!) {
  acceptAiAutonomyOffer(id: $id) {
    errors
    offer {
      ...AiAutonomyOfferFragment
    }
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "acceptAiAutonomyOffer": {
      "errors": ["abc123"],
      "offer": AiAutonomyOffer
    }
  }
}

acceptAllyInvite

Description

Accepts an accountability-partner invite by token. Creates or upgrades the relationship to an accepted partnership.

Response

Returns an AcceptAllyInvitePayload!

Arguments
Name Description
inviteToken - String! Token from the invite deep link.

Example

Query
mutation acceptAllyInvite($inviteToken: String!) {
  acceptAllyInvite(inviteToken: $inviteToken) {
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"inviteToken": "xyz789"}
Response
{
  "data": {
    "acceptAllyInvite": {
      "errors": ["xyz789"],
      "userAlly": UserAlly
    }
  }
}

acceptAllyRequest

Description

Accepts a pending ally request.

Response

Returns an AcceptAllyRequestPayload!

Arguments
Name Description
requestId - ID! public_id of the UserAlly record (the pending request) to accept.

Example

Query
mutation acceptAllyRequest($requestId: ID!) {
  acceptAllyRequest(requestId: $requestId) {
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"requestId": "4"}
Response
{
  "data": {
    "acceptAllyRequest": {
      "errors": ["abc123"],
      "userAlly": UserAlly
    }
  }
}

acceptHabitIntegrationMapping

Description

Accepts a proposed (or manual) mapping from a connected provider activity type to a habit.

Arguments
Name Description
confidenceScore - Float Score from the auto-mapping engine, if any.
goalId - ID! public_id of the habit to map the activity type to.
integrationConnectionId - ID! public_id of the connection being mapped.
providerActivityType - String! e.g. "Strava.run", "Chess.com.game".

Example

Query
mutation acceptHabitIntegrationMapping(
  $confidenceScore: Float,
  $goalId: ID!,
  $integrationConnectionId: ID!,
  $providerActivityType: String!
) {
  acceptHabitIntegrationMapping(
    confidenceScore: $confidenceScore,
    goalId: $goalId,
    integrationConnectionId: $integrationConnectionId,
    providerActivityType: $providerActivityType
  ) {
    errors
    mapping {
      ...HabitIntegrationMappingFragment
    }
  }
}
Variables
{
  "confidenceScore": 987.65,
  "goalId": 4,
  "integrationConnectionId": 4,
  "providerActivityType": "xyz789"
}
Response
{
  "data": {
    "acceptHabitIntegrationMapping": {
      "errors": ["xyz789"],
      "mapping": HabitIntegrationMapping
    }
  }
}

acceptPaceSuggestion

Description

Applies a pace suggestion's computed target date to the goal (one-tap accept).

Response

Returns an AcceptPaceSuggestionPayload!

Arguments
Name Description
goalId - ID! public_id of the goal the suggestion targets.

Example

Query
mutation acceptPaceSuggestion($goalId: ID!) {
  acceptPaceSuggestion(goalId: $goalId) {
    errors
    goal {
      ...GoalFragment
    }
    previousTargetDate
    proposedTargetDate
  }
}
Variables
{"goalId": "4"}
Response
{
  "data": {
    "acceptPaceSuggestion": {
      "errors": ["abc123"],
      "goal": Goal,
      "previousTargetDate": "xyz789",
      "proposedTargetDate": "xyz789"
    }
  }
}

acceptPartnerRequest

Description

Accepts a pending accountability partner request from an ally.

Response

Returns an AcceptPartnerRequestPayload!

Arguments
Name Description
allyPublicId - ID! public_id of the ally whose partner request to accept.

Example

Query
mutation acceptPartnerRequest($allyPublicId: ID!) {
  acceptPartnerRequest(allyPublicId: $allyPublicId) {
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"allyPublicId": "4"}
Response
{
  "data": {
    "acceptPartnerRequest": {
      "errors": ["abc123"],
      "userAlly": UserAlly
    }
  }
}

acceptStreakMercy

Description

Accepts the Streak Mercy offer — backfills system-granted freeze completions for all missed days to genuinely restore the habit streak, then marks the offer consumed.

Response

Returns an AcceptStreakMercyPayload!

Arguments
Name Description
goalId - ID! public_id of the habit goal to restore.

Example

Query
mutation acceptStreakMercy($goalId: ID!) {
  acceptStreakMercy(goalId: $goalId) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": 4}
Response
{
  "data": {
    "acceptStreakMercy": {
      "errors": ["abc123"],
      "goal": Goal
    }
  }
}

acceptTeamInvite

Description

Called by the invitee once they are signed up and authenticated. No team-scoped authorization — the accepting user has no membership yet.

Response

Returns an AcceptTeamInvitePayload!

Arguments
Name Description
code - String!

Example

Query
mutation acceptTeamInvite($code: String!) {
  acceptTeamInvite(code: $code) {
    communityCount
    errors
    preselectedCommunityIds
    seatCapExceeded
    team {
      ...TeamFragment
    }
    teamMembership {
      ...TeamMembershipFragment
    }
  }
}
Variables
{"code": "xyz789"}
Response
{
  "data": {
    "acceptTeamInvite": {
      "communityCount": 987,
      "errors": ["xyz789"],
      "preselectedCommunityIds": ["xyz789"],
      "seatCapExceeded": false,
      "team": Team,
      "teamMembership": TeamMembership
    }
  }
}

acknowledgeAction

Description

Marks a gamification action as acknowledged, clearing it from the user action queue.

Response

Returns an AcknowledgeActionPayload!

Arguments
Name Description
id - ID! The public ID of the user action to acknowledge.

Example

Query
mutation acknowledgeAction($id: ID!) {
  acknowledgeAction(id: $id) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "acknowledgeAction": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

acknowledgeAllNotifications

Description

Marks every unread notification as acknowledged for the authenticated user, optionally scoped to a single team (mirrors notificationHistory's teamId).

Arguments
Name Description
teamId - ID Scope to one team's notifications instead of the whole inbox.

Example

Query
mutation acknowledgeAllNotifications($teamId: ID) {
  acknowledgeAllNotifications(teamId: $teamId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"teamId": "4"}
Response
{
  "data": {
    "acknowledgeAllNotifications": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

acknowledgeChallengeCelebration

Description

Marks the current user's challenge-completion celebration as seen. Idempotent — owner-only, a participant row that is not yours is NOT_FOUND.

Arguments
Name Description
id - ID! public_id of the challenge participant row to acknowledge.

Example

Query
mutation acknowledgeChallengeCelebration($id: ID!) {
  acknowledgeChallengeCelebration(id: $id) {
    errors
    participantId
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "acknowledgeChallengeCelebration": {
      "errors": ["xyz789"],
      "participantId": 4
    }
  }
}

acknowledgeCollectiveGoalPrivacyContract

Description

First-time-only server-side acknowledgment of TeamPrivacyContractView (N18/GOALS-16). Persists in UserAction, never localStorage.

Example

Query
mutation acknowledgeCollectiveGoalPrivacyContract {
  acknowledgeCollectiveGoalPrivacyContract {
    acknowledged
    errors
  }
}
Response
{
  "data": {
    "acknowledgeCollectiveGoalPrivacyContract": {
      "acknowledged": false,
      "errors": ["xyz789"]
    }
  }
}

acknowledgeEncouragementCelebration

Description

Marks the current user's encouragement celebration as seen and consumes every other unseen one. Idempotent. Owner-only — a celebration that is not yours is NOT_FOUND.

Arguments
Name Description
id - ID! public_id of the celebration to acknowledge.

Example

Query
mutation acknowledgeEncouragementCelebration($id: ID!) {
  acknowledgeEncouragementCelebration(id: $id) {
    celebrationId
    errors
    moment
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "acknowledgeEncouragementCelebration": {
      "celebrationId": 4,
      "errors": ["xyz789"],
      "moment": "COMPLETED"
    }
  }
}

acknowledgeNotification

Description

Marks a notification as acknowledged (read/dismissed) for the authenticated user.

Response

Returns an AcknowledgeNotificationPayload!

Arguments
Name Description
id - ID! The public ID of the notification to acknowledge.

Example

Query
mutation acknowledgeNotification($id: ID!) {
  acknowledgeNotification(id: $id) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "acknowledgeNotification": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

acknowledgePactCelebration

Description

Marks the viewer's Finish/Ended celebration as seen (D21.2). Idempotent; call it once the Finish screen presents, or on mount for Ended.

Arguments
Name Description
pactId - ID!

Example

Query
mutation acknowledgePactCelebration($pactId: ID!) {
  acknowledgePactCelebration(pactId: $pactId) {
    errors
    pact {
      ...PactFragment
    }
  }
}
Variables
{"pactId": "4"}
Response
{
  "data": {
    "acknowledgePactCelebration": {
      "errors": ["abc123"],
      "pact": Pact
    }
  }
}

acknowledgePactTakeover

Description

Marks the viewer's current-period Pact takeover as played (D10, D20.1). Idempotent; call it once the takeover plays, or when encouragement_takeover_enabled is off.

Response

Returns an AcknowledgePactTakeoverPayload!

Arguments
Name Description
pactId - ID!

Example

Query
mutation acknowledgePactTakeover($pactId: ID!) {
  acknowledgePactTakeover(pactId: $pactId) {
    errors
    pact {
      ...PactFragment
    }
  }
}
Variables
{"pactId": 4}
Response
{
  "data": {
    "acknowledgePactTakeover": {
      "errors": ["abc123"],
      "pact": Pact
    }
  }
}

acknowledgeStreakRecountNote

Description

Acknowledges the one-time streak recount note (OBJ-4243), so it never shows again for this user.

Example

Query
mutation acknowledgeStreakRecountNote {
  acknowledgeStreakRecountNote {
    errors
    success
  }
}
Response
{
  "data": {
    "acknowledgeStreakRecountNote": {
      "errors": ["abc123"],
      "success": false
    }
  }
}

addAiAssignmentComment

Description

Posts a message to an assignment thread. comment/change_request can wake the agent; approval_note never does.

Response

Returns an AddAiAssignmentCommentPayload!

Arguments
Name Description
artifactId - String Pins the comment to a specific artifact.
assignmentId - String!
body - String!
kind - String comment, change_request or approval_note. Default = "comment"

Example

Query
mutation addAiAssignmentComment(
  $artifactId: String,
  $assignmentId: String!,
  $body: String!,
  $kind: String
) {
  addAiAssignmentComment(
    artifactId: $artifactId,
    assignmentId: $assignmentId,
    body: $body,
    kind: $kind
  ) {
    comment {
      ...AiAssignmentCommentFragment
    }
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{
  "artifactId": "abc123",
  "assignmentId": "abc123",
  "body": "abc123",
  "kind": "comment"
}
Response
{
  "data": {
    "addAiAssignmentComment": {
      "comment": AiAssignmentComment,
      "errors": ["abc123"],
      "run": AiRun
    }
  }
}

addCommunitySuggestion

Description

Submits a suggestion for a new community topic or interest area.

Response

Returns an AddCommunitySuggestionPayload!

Arguments
Name Description
content - String! A description of the suggested community topic or interest area.
goalCategoryId - ID Optional public ID of a goal category to associate with the suggestion.
goalTypeId - ID Optional public ID of a goal type that best represents the suggested community.

Example

Query
mutation addCommunitySuggestion(
  $content: String!,
  $goalCategoryId: ID,
  $goalTypeId: ID
) {
  addCommunitySuggestion(
    content: $content,
    goalCategoryId: $goalCategoryId,
    goalTypeId: $goalTypeId
  ) {
    communitySuggestion {
      ...CommunitySuggestionFragment
    }
    errors
  }
}
Variables
{
  "content": "xyz789",
  "goalCategoryId": 4,
  "goalTypeId": 4
}
Response
{
  "data": {
    "addCommunitySuggestion": {
      "communitySuggestion": CommunitySuggestion,
      "errors": ["abc123"]
    }
  }
}

addGoal

Description

Creates a new goal for the authenticated user.

Response

Returns an AddGoalPayload!

Arguments
Name Description
appLink - String External app URL (https:// or a custom app scheme, e.g. duolingo://) opened on check-in for one-click redirect to another app.
content - String Optional longer description or motivation note.
daysToUpdate - Int How frequently in days the user plans to log progress.
durationMinutes - Int Optional time-per-session in minutes for habits.
file - Upload Cover image file upload. Takes precedence over image_url when provided.
fromIdeaId - ID public_id of the GoalIdea this goal is created from (Ten -> One). Marks the idea promoted once the goal saves. A stale, foreign, or already-promoted id never fails goal creation.
fromTemplateId - ID public_id of the GoalTemplate this goal is created from. Triggers milestone creation and goal_created_from_template telemetry.
goalCategoryId - ID ID of the goal category (fitness, learning, etc.). Fetch options via goalCategories query.
goalShape - String Finish line / Habit / Someday picker value (sprint, arc, habit, life-list). When present, wins over goalTypeId and maps target date / recurrence / daysToUpdate server-side (see GoalTracking::GoalShapeAttributes).
goalTypeId - ID ID of the goal type (habit, milestone, quantity). Fetch options via goalKinds query.
habitCadence - PracticeCadenceEnum Cadence for the habit-shape path. Ignored unless goalShape is habit, and loses to an explicit recurrenceType/recurrenceDays/recurrenceInterval.
habitWeeklyTarget - Int Times per week for habitCadence TIMES_PER_WEEK: 1-6, defaults to 3. Ignored for every other cadence and unless goalShape is habit.
identityPrompt - String Optional free-text identity framing (e.g. "Who you're becoming"). Personalizes Coach messaging when present. Max 240 chars.
identityPromptQuotable - Boolean Send true alongside identityPrompt when the client shows disclosure copy that reminders may quote this text verbatim. Defaults to false (not quotable).
imageUrl - String URL of a cover image for the goal.
includeTemplatePractices - Boolean When true and fromTemplateId is present, creates the template's bundled practices (≤2) alongside the goal. Defaults to false, so addGoal(fromTemplateId:) alone is unchanged (v4.93 Phase 7).
lifeArea - String The area of life this goal belongs to (e.g. career, health).
milestones - [MilestoneInput!] Ordered milestone steps to create atomically with the goal. Consumed when fromTemplateId is present.
name - String! Display name of the goal (e.g. "Run a 5K").
parentGoalId - ID public_id of a parent goal to nest this under as a milestone.
pastAttemptContext - String Optional free-text context on a prior attempt at this goal. Personalizes Coach messaging when present. Max 200 chars.
private - Boolean Deprecated; use visibility. When true, the goal is visible only to the owner. Defaults to false.
recurrenceDays - [String!] Days for weekly/custom_days recurrence (e.g. ["mon", "wed", "fri"]).
recurrenceInterval - Int Number of days between check-ins for interval recurrence.
recurrenceType - String Recurrence pattern for habits: daily, weekly, custom_days, times_per_week, or interval.
supportsGoalId - ID public_id of a long goal this top-level habit practices toward. Only valid on a top-level habit, targeting the same user's top-level, non-habit goal.
targetAmount - Float Measure target (e.g. 100 for "run 100 miles"). Must be paired with unit — sending one without the other clears both (v4.109).
targetDate - String ISO date string for the target completion date (e.g. "2026-12-31").
unit - String Measure unit (e.g. "miles"), max 20 chars. Paired with targetAmount (v4.109).
visibility - GoalVisibilityEnum Who can see the goal. Wins over private when both are sent.
weeklyTarget - Int Check-ins per week (1-6) for an explicit recurrenceType times_per_week. Cleared whenever the recurrence type is anything else.

Example

Query
mutation addGoal(
  $appLink: String,
  $content: String,
  $daysToUpdate: Int,
  $durationMinutes: Int,
  $file: Upload,
  $fromIdeaId: ID,
  $fromTemplateId: ID,
  $goalCategoryId: ID,
  $goalShape: String,
  $goalTypeId: ID,
  $habitCadence: PracticeCadenceEnum,
  $habitWeeklyTarget: Int,
  $identityPrompt: String,
  $identityPromptQuotable: Boolean,
  $imageUrl: String,
  $includeTemplatePractices: Boolean,
  $lifeArea: String,
  $milestones: [MilestoneInput!],
  $name: String!,
  $parentGoalId: ID,
  $pastAttemptContext: String,
  $private: Boolean,
  $recurrenceDays: [String!],
  $recurrenceInterval: Int,
  $recurrenceType: String,
  $supportsGoalId: ID,
  $targetAmount: Float,
  $targetDate: String,
  $unit: String,
  $visibility: GoalVisibilityEnum,
  $weeklyTarget: Int
) {
  addGoal(
    appLink: $appLink,
    content: $content,
    daysToUpdate: $daysToUpdate,
    durationMinutes: $durationMinutes,
    file: $file,
    fromIdeaId: $fromIdeaId,
    fromTemplateId: $fromTemplateId,
    goalCategoryId: $goalCategoryId,
    goalShape: $goalShape,
    goalTypeId: $goalTypeId,
    habitCadence: $habitCadence,
    habitWeeklyTarget: $habitWeeklyTarget,
    identityPrompt: $identityPrompt,
    identityPromptQuotable: $identityPromptQuotable,
    imageUrl: $imageUrl,
    includeTemplatePractices: $includeTemplatePractices,
    lifeArea: $lifeArea,
    milestones: $milestones,
    name: $name,
    parentGoalId: $parentGoalId,
    pastAttemptContext: $pastAttemptContext,
    private: $private,
    recurrenceDays: $recurrenceDays,
    recurrenceInterval: $recurrenceInterval,
    recurrenceType: $recurrenceType,
    supportsGoalId: $supportsGoalId,
    targetAmount: $targetAmount,
    targetDate: $targetDate,
    unit: $unit,
    visibility: $visibility,
    weeklyTarget: $weeklyTarget
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{
  "appLink": "abc123",
  "content": "xyz789",
  "daysToUpdate": 987,
  "durationMinutes": 123,
  "file": Upload,
  "fromIdeaId": 4,
  "fromTemplateId": "4",
  "goalCategoryId": "4",
  "goalShape": "abc123",
  "goalTypeId": 4,
  "habitCadence": "DAILY",
  "habitWeeklyTarget": 987,
  "identityPrompt": "abc123",
  "identityPromptQuotable": true,
  "imageUrl": "abc123",
  "includeTemplatePractices": false,
  "lifeArea": "xyz789",
  "milestones": [MilestoneInput],
  "name": "abc123",
  "parentGoalId": "4",
  "pastAttemptContext": "abc123",
  "private": false,
  "recurrenceDays": ["xyz789"],
  "recurrenceInterval": 987,
  "recurrenceType": "xyz789",
  "supportsGoalId": "4",
  "targetAmount": 987.65,
  "targetDate": "xyz789",
  "unit": "xyz789",
  "visibility": "ALLIES",
  "weeklyTarget": 987
}
Response
{
  "data": {
    "addGoal": {
      "errors": ["abc123"],
      "goal": Goal
    }
  }
}

addGoalEvent

Description

Logs a progress event for a goal. Each event is immutable once created.

Response

Returns an AddGoalEventPayload!

Arguments
Name Description
amount - Float Optional quantity for this update, accepted only on a goal with a live cause challenge, must be greater than 0 (v4.126 D3).
clientEventId - String Client-generated UUID for idempotent retry of offline-queued events. Repeat calls with the same client_event_id return the original event.
clientTimestamp - String ISO-8601 local timestamp when the event actually occurred. Used as effective time for streak calculation. Must be within the last 7 days; an update stamped on an earlier day than it was received is recorded as a late entry.
content - String The progress update text describing what was accomplished. Optional only when amount is set on a goal with a live cause challenge (v4.126 D1/2.0).
file - Upload Image file upload. Takes precedence over image_url when provided.
goalId - ID! public_id of the goal this progress event belongs to.
imageUrl - String Optional URL of an image to attach to the progress event.
mood - String Optional mood at the time of logging (e.g. amazing, happy, calm, meh, tired, low).

Example

Query
mutation addGoalEvent(
  $amount: Float,
  $clientEventId: String,
  $clientTimestamp: String,
  $content: String,
  $file: Upload,
  $goalId: ID!,
  $imageUrl: String,
  $mood: String
) {
  addGoalEvent(
    amount: $amount,
    clientEventId: $clientEventId,
    clientTimestamp: $clientTimestamp,
    content: $content,
    file: $file,
    goalId: $goalId,
    imageUrl: $imageUrl,
    mood: $mood
  ) {
    errors
    goalEvent {
      ...GoalEventFragment
    }
    xpAwarded
  }
}
Variables
{
  "amount": 987.65,
  "clientEventId": "xyz789",
  "clientTimestamp": "xyz789",
  "content": "xyz789",
  "file": Upload,
  "goalId": 4,
  "imageUrl": "xyz789",
  "mood": "xyz789"
}
Response
{
  "data": {
    "addGoalEvent": {
      "errors": ["xyz789"],
      "goalEvent": GoalEvent,
      "xpAwarded": 123
    }
  }
}

addGoalEventComment

Description

Adds a comment to a goal progress event.

Response

Returns an AddGoalEventCommentPayload!

Arguments
Name Description
content - String The text body of the comment.
goalEventId - ID! public_id of the goal event to comment on.

Example

Query
mutation addGoalEventComment(
  $content: String,
  $goalEventId: ID!
) {
  addGoalEventComment(
    content: $content,
    goalEventId: $goalEventId
  ) {
    errors
    goalEventComment {
      ...GoalEventCommentFragment
    }
  }
}
Variables
{"content": "xyz789", "goalEventId": 4}
Response
{
  "data": {
    "addGoalEventComment": {
      "errors": ["xyz789"],
      "goalEventComment": GoalEventComment
    }
  }
}

addGoalToCommunity

Description

Shares an existing goal into a community feed.

Response

Returns an AddGoalToCommunityPayload!

Arguments
Name Description
communityId - ID! public_id of the community to share the goal into.
goalId - ID! public_id of the goal to share into the community.

Example

Query
mutation addGoalToCommunity(
  $communityId: ID!,
  $goalId: ID!
) {
  addGoalToCommunity(
    communityId: $communityId,
    goalId: $goalId
  ) {
    communityGoal {
      ...CommunityGoalFragment
    }
    errors
  }
}
Variables
{
  "communityId": "4",
  "goalId": "4"
}
Response
{
  "data": {
    "addGoalToCommunity": {
      "communityGoal": CommunityGoal,
      "errors": ["xyz789"]
    }
  }
}

addMoodLog

Description

Records a mood check-in for the authenticated user. Mood options: amazing, happy, calm, meh, tired, low.

Response

Returns an AddMoodLogPayload!

Arguments
Name Description
goalId - ID Optional public ID of a goal to associate with this mood check-in.
mood - String! The mood value for this check-in. Accepted values: amazing, happy, calm, meh, tired, low.
note - String An optional free-text note accompanying the mood entry (max 300 characters).

Example

Query
mutation addMoodLog(
  $goalId: ID,
  $mood: String!,
  $note: String
) {
  addMoodLog(
    goalId: $goalId,
    mood: $mood,
    note: $note
  ) {
    errors
    moodLog {
      ...MoodLogFragment
    }
  }
}
Variables
{
  "goalId": "4",
  "mood": "xyz789",
  "note": "xyz789"
}
Response
{
  "data": {
    "addMoodLog": {
      "errors": ["abc123"],
      "moodLog": MoodLog
    }
  }
}

addPostComment

Description

Adds a comment to a community post.

Response

Returns an AddPostCommentPayload!

Arguments
Name Description
content - String! Text content of the comment.
postId - ID! ID of the community post to comment on.

Example

Query
mutation addPostComment(
  $content: String!,
  $postId: ID!
) {
  addPostComment(
    content: $content,
    postId: $postId
  ) {
    errors
    postComment {
      ...PostCommentFragment
    }
  }
}
Variables
{"content": "xyz789", "postId": 4}
Response
{
  "data": {
    "addPostComment": {
      "errors": ["abc123"],
      "postComment": PostComment
    }
  }
}

addPractice

Description

Creates a top-level habit linked to one of the current user's own long goals (the Today zero-habit invitation's Add-practice sheet, v4.93 Phase 4).

Response

Returns an AddPracticePayload!

Arguments
Name Description
goalId - ID! public_id of the long goal this practice will support.
practice - PracticeInput! Name and cadence for the new practice.

Example

Query
mutation addPractice(
  $goalId: ID!,
  $practice: PracticeInput!
) {
  addPractice(
    goalId: $goalId,
    practice: $practice
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{
  "goalId": "4",
  "practice": PracticeInput
}
Response
{
  "data": {
    "addPractice": {
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

adjustTeamSeats

Description

Owner-only. Updates a team's seat count.

Response

Returns an AdjustTeamSeatsPayload!

Arguments
Name Description
seatCount - Int!
teamId - String!

Example

Query
mutation adjustTeamSeats(
  $seatCount: Int!,
  $teamId: String!
) {
  adjustTeamSeats(
    seatCount: $seatCount,
    teamId: $teamId
  ) {
    errors
    teamSubscription {
      ...TeamSubscriptionFragment
    }
  }
}
Variables
{"seatCount": 123, "teamId": "abc123"}
Response
{
  "data": {
    "adjustTeamSeats": {
      "errors": ["xyz789"],
      "teamSubscription": TeamSubscription
    }
  }
}

applyCoachProposal

Description

Apply a Coach proposal: runs its steps in one transaction. Nothing is written to goals until this is called.

Response

Returns an ApplyCoachProposalPayload!

Arguments
Name Description
id - ID! public_id of the Coach proposal.
skipOptional - Boolean When true, the step marked optional is neither applied nor later undone. Default = false

Example

Query
mutation applyCoachProposal(
  $id: ID!,
  $skipOptional: Boolean
) {
  applyCoachProposal(
    id: $id,
    skipOptional: $skipOptional
  ) {
    coachProposal {
      ...CoachProposalFragment
    }
    errors
  }
}
Variables
{"id": 4, "skipOptional": false}
Response
{
  "data": {
    "applyCoachProposal": {
      "coachProposal": CoachProposal,
      "errors": ["xyz789"]
    }
  }
}

approveAiArtifact

Description

Approves a pending AI artifact. Social posts take per-channel edits, images and a draft date. Blog articles take the full edited article. Other kinds take editedPayload.

Response

Returns an ApproveAiArtifactPayload!

Arguments
Name Description
artifactId - String!
content - JSON Social posts: edited text by channel, channels left out keep their text. Blog articles: the full edited article payload.
editedPayload - String
imageUrls - [String!] Social posts: replaces the post's images.
scheduledFor - ISO8601DateTime Social posts: when the draft is for. Still a draft.

Example

Query
mutation approveAiArtifact(
  $artifactId: String!,
  $content: JSON,
  $editedPayload: String,
  $imageUrls: [String!],
  $scheduledFor: ISO8601DateTime
) {
  approveAiArtifact(
    artifactId: $artifactId,
    content: $content,
    editedPayload: $editedPayload,
    imageUrls: $imageUrls,
    scheduledFor: $scheduledFor
  ) {
    artifact {
      ...AiArtifactFragment
    }
    errors
  }
}
Variables
{
  "artifactId": "abc123",
  "content": {},
  "editedPayload": "abc123",
  "imageUrls": ["abc123"],
  "scheduledFor": ISO8601DateTime
}
Response
{
  "data": {
    "approveAiArtifact": {
      "artifact": AiArtifact,
      "errors": ["abc123"]
    }
  }
}

approveAiArtifacts

Description

Approves several pending artifacts as they are. Returns one result per ID; one failure never blocks the rest.

Response

Returns an ApproveAiArtifactsPayload!

Arguments
Name Description
artifactIds - [String!]!

Example

Query
mutation approveAiArtifacts($artifactIds: [String!]!) {
  approveAiArtifacts(artifactIds: $artifactIds) {
    errors
    results {
      ...AiArtifactBulkResultFragment
    }
  }
}
Variables
{"artifactIds": ["abc123"]}
Response
{
  "data": {
    "approveAiArtifacts": {
      "errors": ["abc123"],
      "results": [AiArtifactBulkResult]
    }
  }
}

archiveAiAutopilot

Response

Returns an ArchiveAiAutopilotPayload!

Arguments
Name Description
autopilotId - String!

Example

Query
mutation archiveAiAutopilot($autopilotId: String!) {
  archiveAiAutopilot(autopilotId: $autopilotId) {
    archivedAutopilotId
    errors
  }
}
Variables
{"autopilotId": "xyz789"}
Response
{
  "data": {
    "archiveAiAutopilot": {
      "archivedAutopilotId": "abc123",
      "errors": ["xyz789"]
    }
  }
}

archiveAiEmployee

Response

Returns an ArchiveAiEmployeePayload!

Arguments
Name Description
employeeId - String!

Example

Query
mutation archiveAiEmployee($employeeId: String!) {
  archiveAiEmployee(employeeId: $employeeId) {
    archivedEmployeeId
    errors
  }
}
Variables
{"employeeId": "xyz789"}
Response
{
  "data": {
    "archiveAiEmployee": {
      "archivedEmployeeId": "abc123",
      "errors": ["xyz789"]
    }
  }
}

archiveAiInboxItem

Description

Archives one AI Workforce inbox item for the current viewer. Idempotent.

Response

Returns an ArchiveAiInboxItemPayload!

Arguments
Name Description
id - String!

Example

Query
mutation archiveAiInboxItem($id: String!) {
  archiveAiInboxItem(id: $id) {
    errors
    itemId
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "archiveAiInboxItem": {
      "errors": ["abc123"],
      "itemId": "xyz789"
    }
  }
}

archiveAllAiInboxItems

Description

Archives every currently visible, unarchived AI Workforce inbox item for the current viewer, optionally filtered by type. Bounded at 200 per call; returns the count archived.

Response

Returns an ArchiveAllAiInboxItemsPayload!

Arguments
Name Description
types - [String!] assigned, waiting, failed, delivered or replied.

Example

Query
mutation archiveAllAiInboxItems($types: [String!]) {
  archiveAllAiInboxItems(types: $types) {
    archivedCount
    errors
  }
}
Variables
{"types": ["xyz789"]}
Response
{
  "data": {
    "archiveAllAiInboxItems": {
      "archivedCount": 987,
      "errors": ["xyz789"]
    }
  }
}

archiveFeedbackTag

Description

Archives a feedback tag, hiding it from the pickable list without detaching it from posts (admin only).

Response

Returns an ArchiveFeedbackTagPayload!

Arguments
Name Description
tagId - ID! Public ID of the feedback tag.

Example

Query
mutation archiveFeedbackTag($tagId: ID!) {
  archiveFeedbackTag(tagId: $tagId) {
    errors
    feedbackTag {
      ...FeedbackTagFragment
    }
  }
}
Variables
{"tagId": "4"}
Response
{
  "data": {
    "archiveFeedbackTag": {
      "errors": ["xyz789"],
      "feedbackTag": FeedbackTag
    }
  }
}

archiveSubCommunity

Description

Owner/Admin-only. Starts the 30-day read-only archive window for a sub-community.

Response

Returns an ArchiveSubCommunityPayload!

Arguments
Name Description
communityId - String!
teamId - String!

Example

Query
mutation archiveSubCommunity(
  $communityId: String!,
  $teamId: String!
) {
  archiveSubCommunity(
    communityId: $communityId,
    teamId: $teamId
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "communityId": "abc123",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "archiveSubCommunity": {
      "community": Community,
      "errors": ["xyz789"]
    }
  }
}

beginDataImport

Description

Parses an uploaded goals/habit_completions CSV pair into a staged DataImport preview.

Response

Returns a BeginImportPayload!

Arguments
Name Description
goalsFile - Upload goals.csv upload.
habitCompletionsFile - Upload habit_completions.csv upload.

Example

Query
mutation beginDataImport(
  $goalsFile: Upload,
  $habitCompletionsFile: Upload
) {
  beginDataImport(
    goalsFile: $goalsFile,
    habitCompletionsFile: $habitCompletionsFile
  ) {
    dataImport {
      ...DataImportFragment
    }
    errors
  }
}
Variables
{
  "goalsFile": Upload,
  "habitCompletionsFile": Upload
}
Response
{
  "data": {
    "beginDataImport": {
      "dataImport": DataImport,
      "errors": ["abc123"]
    }
  }
}

blockAlly

Description

Blocks a user, preventing ally requests in either direction.

Response

Returns a BlockAllyPayload!

Arguments
Name Description
targetUserId - ID! public_id of the user to block.

Example

Query
mutation blockAlly($targetUserId: ID!) {
  blockAlly(targetUserId: $targetUserId) {
    errors
    success
  }
}
Variables
{"targetUserId": 4}
Response
{
  "data": {
    "blockAlly": {
      "errors": ["abc123"],
      "success": true
    }
  }
}

bulkReviewContentFlags

Description

Reviews up to 50 content flags atomically. Requires moderator+ role.

Response

Returns a BulkReviewContentFlagsPayload!

Arguments
Name Description
action - String! "approve" or "reject".
flagIds - [String!]! Array of flag public_ids (max 50).
reason - String! Bulk reason (min 3 chars, recorded per flag).

Example

Query
mutation bulkReviewContentFlags(
  $action: String!,
  $flagIds: [String!]!,
  $reason: String!
) {
  bulkReviewContentFlags(
    action: $action,
    flagIds: $flagIds,
    reason: $reason
  ) {
    errors
    reviewedCount
  }
}
Variables
{
  "action": "xyz789",
  "flagIds": ["xyz789"],
  "reason": "abc123"
}
Response
{
  "data": {
    "bulkReviewContentFlags": {
      "errors": ["abc123"],
      "reviewedCount": 987
    }
  }
}

cancelAllyRequest

Description

Cancels a pending ally request you sent.

Response

Returns a CancelAllyRequestPayload!

Arguments
Name Description
targetUserId - ID! public_id of the pending request's target user.

Example

Query
mutation cancelAllyRequest($targetUserId: ID!) {
  cancelAllyRequest(targetUserId: $targetUserId) {
    errors
    success
  }
}
Variables
{"targetUserId": 4}
Response
{
  "data": {
    "cancelAllyRequest": {
      "errors": ["abc123"],
      "success": false
    }
  }
}

cancelCommunityEvent

Description

Cancels (soft-deletes) a meetup. The creator, a community admin/moderator, or a site admin (D2).

Response

Returns a CancelCommunityEventPayload!

Arguments
Name Description
eventId - ID! public_id of the meetup to cancel.

Example

Query
mutation cancelCommunityEvent($eventId: ID!) {
  cancelCommunityEvent(eventId: $eventId) {
    communityEvent {
      ...CommunityEventFragment
    }
    errorCode
    errors
  }
}
Variables
{"eventId": 4}
Response
{
  "data": {
    "cancelCommunityEvent": {
      "communityEvent": CommunityEvent,
      "errorCode": "abc123",
      "errors": ["xyz789"]
    }
  }
}

cancelHeadCoachTurn

Description

Ask the running Head Coach turn to stop. The loop honours it between model calls; a queued turn is cancelled immediately. Super-admin only, behind the head_coach_enabled kill switch.

Response

Returns a CancelHeadCoachTurnPayload!

Arguments
Name Description
turnId - ID! public_id of the turn to cancel.

Example

Query
mutation cancelHeadCoachTurn($turnId: ID!) {
  cancelHeadCoachTurn(turnId: $turnId) {
    errors
    success
  }
}
Variables
{"turnId": 4}
Response
{
  "data": {
    "cancelHeadCoachTurn": {
      "errors": ["abc123"],
      "success": false
    }
  }
}

cancelPact

Description

Cancels a forming Pact. Creator only.

Response

Returns a CancelPactPayload!

Arguments
Name Description
pactId - ID!

Example

Query
mutation cancelPact($pactId: ID!) {
  cancelPact(pactId: $pactId) {
    errors
    pact {
      ...PactFragment
    }
  }
}
Variables
{"pactId": 4}
Response
{
  "data": {
    "cancelPact": {
      "errors": ["xyz789"],
      "pact": Pact
    }
  }
}

cancelPartnerRequest

Description

Cancels an outgoing accountability partner request you sent.

Response

Returns a CancelPartnerRequestPayload!

Arguments
Name Description
allyPublicId - ID! public_id of the ally whose outgoing partner request to cancel.

Example

Query
mutation cancelPartnerRequest($allyPublicId: ID!) {
  cancelPartnerRequest(allyPublicId: $allyPublicId) {
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"allyPublicId": 4}
Response
{
  "data": {
    "cancelPartnerRequest": {
      "errors": ["abc123"],
      "userAlly": UserAlly
    }
  }
}

cancelSupporterSubscription

Description

Cancels the current Supporter subscription at the end of the billing period.

Example

Query
mutation cancelSupporterSubscription {
  cancelSupporterSubscription {
    errors
    success
  }
}
Response
{
  "data": {
    "cancelSupporterSubscription": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

cancelTeamSubscription

Description

Owner-only. Cancels a team's subscription.

Response

Returns a CancelTeamSubscriptionPayload!

Arguments
Name Description
teamId - String!

Example

Query
mutation cancelTeamSubscription($teamId: String!) {
  cancelTeamSubscription(teamId: $teamId) {
    errors
    success
  }
}
Variables
{"teamId": "abc123"}
Response
{
  "data": {
    "cancelTeamSubscription": {
      "errors": ["xyz789"],
      "success": false
    }
  }
}

checkInHabit

Description

Records a one-tap check-in for a habit goal.

Response

Returns a CheckInHabitPayload!

Arguments
Name Description
clientEventId - String Client-generated UUID for idempotent retry of offline-queued check-ins. Repeat calls with the same client_event_id return the original completion.
clientTimestamp - String ISO-8601 time the user acted on the device. Trusted as the moment of the check-in only with a client_event_id and within 72h of receipt (offline queue, widget drain); otherwise the server receipt time is used.
completedDate - String ISO date string (YYYY-MM-DD) to credit this check-in to, for offline/widget syncs made before the current day. Must be within the last 7 days in the user's timezone; omit to default to today. A date before today is recorded as a late entry.
goalId - ID! public_id of the habit goal to check in.
note - String Optional one-sentence journal note for this check-in (max 280 characters).

Example

Query
mutation checkInHabit(
  $clientEventId: String,
  $clientTimestamp: String,
  $completedDate: String,
  $goalId: ID!,
  $note: String
) {
  checkInHabit(
    clientEventId: $clientEventId,
    clientTimestamp: $clientTimestamp,
    completedDate: $completedDate,
    goalId: $goalId,
    note: $note
  ) {
    checkinToken
    dayClosedToday
    errors
    goal {
      ...GoalFragment
    }
    habitCompletion {
      ...HabitCompletionFragment
    }
    xpAwarded
  }
}
Variables
{
  "clientEventId": "abc123",
  "clientTimestamp": "xyz789",
  "completedDate": "abc123",
  "goalId": 4,
  "note": "xyz789"
}
Response
{
  "data": {
    "checkInHabit": {
      "checkinToken": "abc123",
      "dayClosedToday": false,
      "errors": ["abc123"],
      "goal": Goal,
      "habitCompletion": HabitCompletion,
      "xpAwarded": 987
    }
  }
}

checkValidUsername

Description

Checks whether a username is available and meets formatting requirements.

Response

Returns a CheckValidUsernamePayload!

Arguments
Name Description
username - String! The username to check for availability and format validity.

Example

Query
mutation checkValidUsername($username: String!) {
  checkValidUsername(username: $username) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"username": "abc123"}
Response
{
  "data": {
    "checkValidUsername": {
      "errors": ["abc123"],
      "result": Result
    }
  }
}

claimAiArtifact

Description

Claims a pending AI artifact for the reviewing operator without resolving it.

Response

Returns a ClaimAiArtifactPayload!

Arguments
Name Description
artifactId - String!

Example

Query
mutation claimAiArtifact($artifactId: String!) {
  claimAiArtifact(artifactId: $artifactId) {
    artifact {
      ...AiArtifactFragment
    }
    errors
  }
}
Variables
{"artifactId": "xyz789"}
Response
{
  "data": {
    "claimAiArtifact": {
      "artifact": AiArtifact,
      "errors": ["xyz789"]
    }
  }
}

claimStreakInsurance

Description

Claims the monthly streak insurance benefit, restoring a broken streak with no XP cost.

Response

Returns a ClaimStreakInsurancePayload!

Arguments
Name Description
goalId - ID! public_id of the habit goal to restore via insurance.

Example

Query
mutation claimStreakInsurance($goalId: ID!) {
  claimStreakInsurance(goalId: $goalId) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": "4"}
Response
{
  "data": {
    "claimStreakInsurance": {
      "errors": ["abc123"],
      "goal": Goal
    }
  }
}

commitDataImport

Description

Commits a staged DataImport, creating the imported goals and check-ins asynchronously.

Response

Returns a CommitImportPayload!

Arguments
Name Description
id - ID! public_id of the staged DataImport to commit.
skipGoalExternalIds - [String!] external_ids of collision-flagged goal rows to skip. Default = []

Example

Query
mutation commitDataImport(
  $id: ID!,
  $skipGoalExternalIds: [String!]
) {
  commitDataImport(
    id: $id,
    skipGoalExternalIds: $skipGoalExternalIds
  ) {
    dataImport {
      ...DataImportFragment
    }
    errors
  }
}
Variables
{"id": "4", "skipGoalExternalIds": [""]}
Response
{
  "data": {
    "commitDataImport": {
      "dataImport": DataImport,
      "errors": ["xyz789"]
    }
  }
}

completeOnboardingAndCreateGoal

Description

Atomically completes onboarding and creates the first goal.

Arguments
Name Description
goalCategoryId - ID A GoalCategory id, or the onboarding life-area slug (e.g. "health") — resolved to its GoalCategory server-side.
goalName - String!
goalShape - String The goal shape picked on the onboarding goal-shape slide (habit, sprint, arc, life-list). Maps to recurrence/target-date/goal-type server-side.
habitCadence - PracticeCadenceEnum Cadence for the habit-shape path. Ignored unless goalShape is habit; falls back to DAILY (OBJ-5448).
habitWeeklyTarget - Int Times per week for habitCadence TIMES_PER_WEEK on the habit-shape path: 1-6, defaults to 3. Ignored for every other cadence and shape (a practice carries its own target on PracticeInput).
identityPrompt - String The user's own why, at most 240 characters. Dropped (not rejected) when longer (v4.109).
milestones - [String!] First steps for the goal, in order. At most 5, each at most 50 characters; extras, blanks and over-long entries are dropped (v4.109).
onboardingAnswers - JSON
pastAttemptContext - String What got in the way before, at most 200 characters. Dropped (not rejected) when longer (v4.109).
practice - PracticeInput A practice habit to create and link to the new goal. Ignored when goalShape is habit (OBJ-5448).
targetAmount - Float Measure target (> 0). Applied only together with unit; otherwise both are dropped (v4.109).
targetDate - ISO8601Date Target date picked on the onboarding goal-shape slide. Only applied for shapes that use a target date (sprint, arc).
unit - String Measure unit (e.g. "books"), at most 20 characters. Paired with targetAmount (v4.109).

Example

Query
mutation completeOnboardingAndCreateGoal(
  $goalCategoryId: ID,
  $goalName: String!,
  $goalShape: String,
  $habitCadence: PracticeCadenceEnum,
  $habitWeeklyTarget: Int,
  $identityPrompt: String,
  $milestones: [String!],
  $onboardingAnswers: JSON,
  $pastAttemptContext: String,
  $practice: PracticeInput,
  $targetAmount: Float,
  $targetDate: ISO8601Date,
  $unit: String
) {
  completeOnboardingAndCreateGoal(
    goalCategoryId: $goalCategoryId,
    goalName: $goalName,
    goalShape: $goalShape,
    habitCadence: $habitCadence,
    habitWeeklyTarget: $habitWeeklyTarget,
    identityPrompt: $identityPrompt,
    milestones: $milestones,
    onboardingAnswers: $onboardingAnswers,
    pastAttemptContext: $pastAttemptContext,
    practice: $practice,
    targetAmount: $targetAmount,
    targetDate: $targetDate,
    unit: $unit
  ) {
    errors
    goal {
      ...GoalFragment
    }
    practice {
      ...GoalFragment
    }
    user {
      ...UserFragment
    }
  }
}
Variables
{
  "goalCategoryId": "4",
  "goalName": "abc123",
  "goalShape": "abc123",
  "habitCadence": "DAILY",
  "habitWeeklyTarget": 987,
  "identityPrompt": "abc123",
  "milestones": ["abc123"],
  "onboardingAnswers": {},
  "pastAttemptContext": "xyz789",
  "practice": PracticeInput,
  "targetAmount": 987.65,
  "targetDate": ISO8601Date,
  "unit": "abc123"
}
Response
{
  "data": {
    "completeOnboardingAndCreateGoal": {
      "errors": ["xyz789"],
      "goal": Goal,
      "practice": Goal,
      "user": User
    }
  }
}

connectChessCom

Description

Connects the current user's Chess.com account by username.

Response

Returns a ConnectChessComPayload!

Arguments
Name Description
externalUsername - String! Chess.com username to connect.

Example

Query
mutation connectChessCom($externalUsername: String!) {
  connectChessCom(externalUsername: $externalUsername) {
    errors
    integrationConnection {
      ...IntegrationConnectionFragment
    }
  }
}
Variables
{"externalUsername": "abc123"}
Response
{
  "data": {
    "connectChessCom": {
      "errors": ["xyz789"],
      "integrationConnection": IntegrationConnection
    }
  }
}

connectGithub

Description

Starts the GitHub OAuth connect flow. Open the returned URL in an in-app browser.

Response

Returns a ConnectGithubPayload!

Example

Query
mutation connectGithub {
  connectGithub {
    authorizeUrl
    errors
  }
}
Response
{
  "data": {
    "connectGithub": {
      "authorizeUrl": "xyz789",
      "errors": ["xyz789"]
    }
  }
}

connectLichess

Description

Connects the current user's Lichess account by username.

Response

Returns a ConnectLichessPayload!

Arguments
Name Description
externalUsername - String! Lichess username to connect.

Example

Query
mutation connectLichess($externalUsername: String!) {
  connectLichess(externalUsername: $externalUsername) {
    errors
    integrationConnection {
      ...IntegrationConnectionFragment
    }
  }
}
Variables
{"externalUsername": "abc123"}
Response
{
  "data": {
    "connectLichess": {
      "errors": ["xyz789"],
      "integrationConnection": IntegrationConnection
    }
  }
}

connectOura

Description

Starts the Oura OAuth connect flow. Open the returned URL in an in-app browser.

Response

Returns a ConnectOuraPayload!

Example

Query
mutation connectOura {
  connectOura {
    authorizeUrl
    errors
  }
}
Response
{
  "data": {
    "connectOura": {
      "authorizeUrl": "xyz789",
      "errors": ["abc123"]
    }
  }
}

connectStrava

Description

Starts the Strava OAuth connect flow. Open the returned URL in an in-app browser.

Response

Returns a ConnectStravaPayload!

Example

Query
mutation connectStrava {
  connectStrava {
    authorizeUrl
    errors
  }
}
Response
{
  "data": {
    "connectStrava": {
      "authorizeUrl": "xyz789",
      "errors": ["xyz789"]
    }
  }
}

connectWithings

Description

Starts the Withings OAuth connect flow. Open the returned URL in an in-app browser.

Response

Returns a ConnectWithingsPayload!

Example

Query
mutation connectWithings {
  connectWithings {
    authorizeUrl
    errors
  }
}
Response
{
  "data": {
    "connectWithings": {
      "authorizeUrl": "abc123",
      "errors": ["xyz789"]
    }
  }
}

continueGoal

Description

Accepts a completed measure goal's successor offer (v4.113 D7): creates a linked successor with the progress carried over, copies live follows, and closes the original offer for good.

Response

Returns a ContinueGoalPayload!

Arguments
Name Description
goalId - ID! public_id of the completed goal whose offer is being accepted.
name - String! The successor's name, 1-50 chars.
targetAmount - Float! The chosen (or custom) target for the successor.
targetDate - String ISO date string for the successor's target date, if any.

Example

Query
mutation continueGoal(
  $goalId: ID!,
  $name: String!,
  $targetAmount: Float!,
  $targetDate: String
) {
  continueGoal(
    goalId: $goalId,
    name: $name,
    targetAmount: $targetAmount,
    targetDate: $targetDate
  ) {
    errorCode
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{
  "goalId": 4,
  "name": "abc123",
  "targetAmount": 987.65,
  "targetDate": "abc123"
}
Response
{
  "data": {
    "continueGoal": {
      "errorCode": "abc123",
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

controlHeadCoachBulkRun

Description

Pause, resume or stop a Head Coach bulk run. Only the admin who started it, and only while their role still covers the run's item tool. Super-admin only, behind the head_coach_enabled kill switch.

Response

Returns a ControlHeadCoachBulkRunPayload!

Arguments
Name Description
actionId - ID! public_id of the start_bulk_run action (the run id).
command - HeadCoachBulkRunCommandEnum!

Example

Query
mutation controlHeadCoachBulkRun(
  $actionId: ID!,
  $command: HeadCoachBulkRunCommandEnum!
) {
  controlHeadCoachBulkRun(
    actionId: $actionId,
    command: $command
  ) {
    errors
    run {
      ...HeadCoachBulkRunFragment
    }
    success
  }
}
Variables
{"actionId": "4", "command": "PAUSE"}
Response
{
  "data": {
    "controlHeadCoachBulkRun": {
      "errors": ["abc123"],
      "run": HeadCoachBulkRun,
      "success": true
    }
  }
}

createAiAssignment

Response

Returns a CreateAiAssignmentPayload!

Arguments
Name Description
description - String
ownerId - String! public_id of the agent that owns it.
parentId - String public_id of the parent assignment, for a sub-assignment.
start - Boolean Also queue the owner's first run on this assignment. Default = false
title - String!

Example

Query
mutation createAiAssignment(
  $description: String,
  $ownerId: String!,
  $parentId: String,
  $start: Boolean,
  $title: String!
) {
  createAiAssignment(
    description: $description,
    ownerId: $ownerId,
    parentId: $parentId,
    start: $start,
    title: $title
  ) {
    assignment {
      ...AiAssignmentFragment
    }
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{
  "description": "xyz789",
  "ownerId": "xyz789",
  "parentId": "xyz789",
  "start": false,
  "title": "abc123"
}
Response
{
  "data": {
    "createAiAssignment": {
      "assignment": AiAssignment,
      "errors": ["abc123"],
      "run": AiRun
    }
  }
}

createAiAssignmentFromChat

Description

Confirms a task drafted in a chat conversation into a todo AiAssignment, owned by the session's own agent, and queues its first run.

Arguments
Name Description
description - String
draftMessageId - String The agent chat message whose task draft this confirms. One task per draft.
sessionId - String!
title - String!

Example

Query
mutation createAiAssignmentFromChat(
  $description: String,
  $draftMessageId: String,
  $sessionId: String!,
  $title: String!
) {
  createAiAssignmentFromChat(
    description: $description,
    draftMessageId: $draftMessageId,
    sessionId: $sessionId,
    title: $title
  ) {
    assignment {
      ...AiAssignmentFragment
    }
    errors
  }
}
Variables
{
  "description": "xyz789",
  "draftMessageId": "abc123",
  "sessionId": "abc123",
  "title": "abc123"
}
Response
{
  "data": {
    "createAiAssignmentFromChat": {
      "assignment": AiAssignment,
      "errors": ["xyz789"]
    }
  }
}

createAiAutopilot

Response

Returns a CreateAiAutopilotPayload!

Arguments
Name Description
cooldownSeconds - Int
employeeId - String!
eventKind - String
filter - JSON
instructions - String! What the agent should do on each run.
name - String!
postsPerRun - Int Added to the instructions each run.
scheduleCron - String! Five-field cron, read in timeZone. Pass an empty string for an event-triggered autopilot.
timeZone - String IANA time zone. Defaults to America/Chicago.
triggerType - String schedule (default) or event. Event autopilots always start paused.

Example

Query
mutation createAiAutopilot(
  $cooldownSeconds: Int,
  $employeeId: String!,
  $eventKind: String,
  $filter: JSON,
  $instructions: String!,
  $name: String!,
  $postsPerRun: Int,
  $scheduleCron: String!,
  $timeZone: String,
  $triggerType: String
) {
  createAiAutopilot(
    cooldownSeconds: $cooldownSeconds,
    employeeId: $employeeId,
    eventKind: $eventKind,
    filter: $filter,
    instructions: $instructions,
    name: $name,
    postsPerRun: $postsPerRun,
    scheduleCron: $scheduleCron,
    timeZone: $timeZone,
    triggerType: $triggerType
  ) {
    autopilot {
      ...AiAutopilotFragment
    }
    errors
  }
}
Variables
{
  "cooldownSeconds": 123,
  "employeeId": "abc123",
  "eventKind": "xyz789",
  "filter": {},
  "instructions": "xyz789",
  "name": "xyz789",
  "postsPerRun": 987,
  "scheduleCron": "xyz789",
  "timeZone": "xyz789",
  "triggerType": "abc123"
}
Response
{
  "data": {
    "createAiAutopilot": {
      "autopilot": AiAutopilot,
      "errors": ["xyz789"]
    }
  }
}

createAiEmployee

Response

Returns a CreateAiEmployeePayload!

Arguments
Name Description
channels - [String!]
crew - String Defaults to marketing. Non-admins can only create marketing agents.
description - String
mcpServers - [String!]
modelPreference - String
monthlyBudgetCents - Int
name - String!
outputKind - String
postFilterSkill - String
skillRefs - [String!]
taskPrompt - String

Example

Query
mutation createAiEmployee(
  $channels: [String!],
  $crew: String,
  $description: String,
  $mcpServers: [String!],
  $modelPreference: String,
  $monthlyBudgetCents: Int,
  $name: String!,
  $outputKind: String,
  $postFilterSkill: String,
  $skillRefs: [String!],
  $taskPrompt: String
) {
  createAiEmployee(
    channels: $channels,
    crew: $crew,
    description: $description,
    mcpServers: $mcpServers,
    modelPreference: $modelPreference,
    monthlyBudgetCents: $monthlyBudgetCents,
    name: $name,
    outputKind: $outputKind,
    postFilterSkill: $postFilterSkill,
    skillRefs: $skillRefs,
    taskPrompt: $taskPrompt
  ) {
    employee {
      ...AiEmployeeFragment
    }
    errors
  }
}
Variables
{
  "channels": ["abc123"],
  "crew": "xyz789",
  "description": "xyz789",
  "mcpServers": ["xyz789"],
  "modelPreference": "xyz789",
  "monthlyBudgetCents": 123,
  "name": "abc123",
  "outputKind": "abc123",
  "postFilterSkill": "xyz789",
  "skillRefs": ["xyz789"],
  "taskPrompt": "xyz789"
}
Response
{
  "data": {
    "createAiEmployee": {
      "employee": AiEmployee,
      "errors": ["xyz789"]
    }
  }
}

createAiTask

Response

Returns a CreateAiTaskPayload!

Arguments
Name Description
dueOn - ISO8601Date
employeeId - String!
instructions - String! What the agent should do this time.
title - String Defaults to the start of the instructions.

Example

Query
mutation createAiTask(
  $dueOn: ISO8601Date,
  $employeeId: String!,
  $instructions: String!,
  $title: String
) {
  createAiTask(
    dueOn: $dueOn,
    employeeId: $employeeId,
    instructions: $instructions,
    title: $title
  ) {
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{
  "dueOn": ISO8601Date,
  "employeeId": "xyz789",
  "instructions": "xyz789",
  "title": "abc123"
}
Response
{
  "data": {
    "createAiTask": {
      "errors": ["xyz789"],
      "run": AiRun
    }
  }
}

createAllyInvite

Description

Creates a new accountability-partner invite token for the authenticated user.

Response

Returns a CreateAllyInvitePayload!

Example

Query
mutation createAllyInvite {
  createAllyInvite {
    errors
    invite {
      ...AllyInviteFragment
    }
  }
}
Response
{
  "data": {
    "createAllyInvite": {
      "errors": ["abc123"],
      "invite": AllyInvite
    }
  }
}

createCheckoutSession

Description

Creates a Stripe Checkout session for a Supporter plan. Returns a redirect URL.

Response

Returns a CreateCheckoutSessionPayload!

Arguments
Name Description
amountCents - Int Custom amount in cents for lifetime plan (min 9900 = $99). Ignored for other plans.
cancelUrl - String! URL to redirect to if the user cancels checkout.
planSlug - String! Plan to purchase: monthly, yearly, or lifetime.
successUrl - String! URL to redirect to after successful checkout.

Example

Query
mutation createCheckoutSession(
  $amountCents: Int,
  $cancelUrl: String!,
  $planSlug: String!,
  $successUrl: String!
) {
  createCheckoutSession(
    amountCents: $amountCents,
    cancelUrl: $cancelUrl,
    planSlug: $planSlug,
    successUrl: $successUrl
  ) {
    checkoutUrl
    errors
  }
}
Variables
{
  "amountCents": 987,
  "cancelUrl": "xyz789",
  "planSlug": "abc123",
  "successUrl": "xyz789"
}
Response
{
  "data": {
    "createCheckoutSession": {
      "checkoutUrl": "xyz789",
      "errors": ["xyz789"]
    }
  }
}

createCollectiveGoal

Description

Owner/Admin-only. Creates a team- or sub-community-scoped collective goal (GOALS-10).

Response

Returns a CreateCollectiveGoalPayload!

Arguments
Name Description
communityId - String
description - String
name - String!
targetMetric - String!
targetValue - Int!
teamId - String!

Example

Query
mutation createCollectiveGoal(
  $communityId: String,
  $description: String,
  $name: String!,
  $targetMetric: String!,
  $targetValue: Int!,
  $teamId: String!
) {
  createCollectiveGoal(
    communityId: $communityId,
    description: $description,
    name: $name,
    targetMetric: $targetMetric,
    targetValue: $targetValue,
    teamId: $teamId
  ) {
    collectiveGoal {
      ...CollectiveGoalFragment
    }
    errors
    teamReadOnly
  }
}
Variables
{
  "communityId": "abc123",
  "description": "abc123",
  "name": "xyz789",
  "targetMetric": "abc123",
  "targetValue": 123,
  "teamId": "abc123"
}
Response
{
  "data": {
    "createCollectiveGoal": {
      "collectiveGoal": CollectiveGoal,
      "errors": ["abc123"],
      "teamReadOnly": true
    }
  }
}

createCommunity

Description

Creates a new community that users can join to share goals and support each other.

Response

Returns a CreateCommunityPayload!

Arguments
Name Description
category - String! The interest category that best represents this community (e.g. fitness, learning, wellness).
coverImageFile - Upload Cover image file upload. Takes precedence over cover_image_url.
coverImageUrl - String Optional URL for the community cover or banner image.
description - String! A short description of the community purpose and focus.
guidelines - String Optional community rules or participation guidelines shown to members.
name - String! The display name of the community.
privacy - String! Visibility setting for the community. Accepted values: public or private.

Example

Query
mutation createCommunity(
  $category: String!,
  $coverImageFile: Upload,
  $coverImageUrl: String,
  $description: String!,
  $guidelines: String,
  $name: String!,
  $privacy: String!
) {
  createCommunity(
    category: $category,
    coverImageFile: $coverImageFile,
    coverImageUrl: $coverImageUrl,
    description: $description,
    guidelines: $guidelines,
    name: $name,
    privacy: $privacy
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "category": "abc123",
  "coverImageFile": Upload,
  "coverImageUrl": "xyz789",
  "description": "abc123",
  "guidelines": "abc123",
  "name": "xyz789",
  "privacy": "xyz789"
}
Response
{
  "data": {
    "createCommunity": {
      "community": Community,
      "errors": ["xyz789"]
    }
  }
}

createCommunityChallenge

Description

Creates a time-boxed challenge inside a community. Community admin only.

Arguments
Name Description
badgeIcon - String! Emoji or icon for the completion badge.
badgeName - String! Name of the completion badge.
communityId - ID! public_id of the community to create the challenge in.
description - String Optional description of the challenge.
endDate - ISO8601Date! Date when the challenge ends.
name - String! Display name of the challenge.
startDate - ISO8601Date! Date when the challenge begins.
targetGoalCount - Int Number of qualifying goal events needed to complete. Defaults to 1.
targetGoalTypeId - ID Optional GoalType ID to restrict which events count. Nil means any goal event counts.

Example

Query
mutation createCommunityChallenge(
  $badgeIcon: String!,
  $badgeName: String!,
  $communityId: ID!,
  $description: String,
  $endDate: ISO8601Date!,
  $name: String!,
  $startDate: ISO8601Date!,
  $targetGoalCount: Int,
  $targetGoalTypeId: ID
) {
  createCommunityChallenge(
    badgeIcon: $badgeIcon,
    badgeName: $badgeName,
    communityId: $communityId,
    description: $description,
    endDate: $endDate,
    name: $name,
    startDate: $startDate,
    targetGoalCount: $targetGoalCount,
    targetGoalTypeId: $targetGoalTypeId
  ) {
    communityChallenge {
      ...CommunityChallengeFragment
    }
    errors
  }
}
Variables
{
  "badgeIcon": "xyz789",
  "badgeName": "abc123",
  "communityId": 4,
  "description": "xyz789",
  "endDate": ISO8601Date,
  "name": "xyz789",
  "startDate": ISO8601Date,
  "targetGoalCount": 123,
  "targetGoalTypeId": "4"
}
Response
{
  "data": {
    "createCommunityChallenge": {
      "communityChallenge": CommunityChallenge,
      "errors": ["xyz789"]
    }
  }
}

createCommunityEvent

Description

Creates a meetup inside a community. Community admin, moderator, or site admin only (D1).

Response

Returns a CreateCommunityEventPayload!

Arguments
Name Description
communityId - ID! public_id of the community to create the meetup in.
description - String Optional details, at most 1,000 characters.
endsAt - ISO8601DateTime Optional end time.
location - String A place or a link for online meetups.
startsAt - ISO8601DateTime! When the meetup starts.
title - String! Title of the meetup.

Example

Query
mutation createCommunityEvent(
  $communityId: ID!,
  $description: String,
  $endsAt: ISO8601DateTime,
  $location: String,
  $startsAt: ISO8601DateTime!,
  $title: String!
) {
  createCommunityEvent(
    communityId: $communityId,
    description: $description,
    endsAt: $endsAt,
    location: $location,
    startsAt: $startsAt,
    title: $title
  ) {
    communityEvent {
      ...CommunityEventFragment
    }
    errorCode
    errors
  }
}
Variables
{
  "communityId": "4",
  "description": "xyz789",
  "endsAt": ISO8601DateTime,
  "location": "xyz789",
  "startsAt": ISO8601DateTime,
  "title": "xyz789"
}
Response
{
  "data": {
    "createCommunityEvent": {
      "communityEvent": CommunityEvent,
      "errorCode": "abc123",
      "errors": ["abc123"]
    }
  }
}

createCommunityPost

Description

Creates a post in a community. Supports text updates and goal shares.

Response

Returns a CreateCommunityPostPayload!

Arguments
Name Description
communityId - ID! The public ID of the community in which to create the post.
content - String! The text body of the post.
type - String! The post type. Accepted values: discussion, achievement, or milestone.

Example

Query
mutation createCommunityPost(
  $communityId: ID!,
  $content: String!,
  $type: String!
) {
  createCommunityPost(
    communityId: $communityId,
    content: $content,
    type: $type
  ) {
    errors
    post {
      ...CommunityPostFragment
    }
  }
}
Variables
{
  "communityId": "4",
  "content": "abc123",
  "type": "abc123"
}
Response
{
  "data": {
    "createCommunityPost": {
      "errors": ["xyz789"],
      "post": CommunityPost
    }
  }
}

createDemoSignInToken

Description

Mints a short-lived Clerk sign-in token for the shared demo account. No arguments; no session required.

Response

Returns a CreateDemoSignInTokenPayload!

Example

Query
mutation createDemoSignInToken {
  createDemoSignInToken {
    errors
    token
  }
}
Response
{
  "data": {
    "createDemoSignInToken": {
      "errors": ["xyz789"],
      "token": "xyz789"
    }
  }
}

createFeedbackComment

Description

Adds a comment to a feedback post.

Response

Returns a CreateFeedbackCommentPayload!

Arguments
Name Description
body - String! Comment text (max 1000 chars).
isOfficial - Boolean Mark as official team response (admin only).
postId - ID! Public ID of the feedback post.

Example

Query
mutation createFeedbackComment(
  $body: String!,
  $isOfficial: Boolean,
  $postId: ID!
) {
  createFeedbackComment(
    body: $body,
    isOfficial: $isOfficial,
    postId: $postId
  ) {
    errors
    feedbackComment {
      ...FeedbackCommentFragment
    }
  }
}
Variables
{
  "body": "abc123",
  "isOfficial": true,
  "postId": 4
}
Response
{
  "data": {
    "createFeedbackComment": {
      "errors": ["xyz789"],
      "feedbackComment": FeedbackComment
    }
  }
}

createFeedbackPost

Description

Creates a new feedback post (feature request, improvement, bug report).

Response

Returns a CreateFeedbackPostPayload!

Arguments
Name Description
category - String! Category: feature, improvement, bug, or other.
description - String Detailed description (max 2000 chars).
tagIds - [ID!] Public IDs of feedback tags to attach (max 3).
title - String! Title of the feedback post (max 200 chars).

Example

Query
mutation createFeedbackPost(
  $category: String!,
  $description: String,
  $tagIds: [ID!],
  $title: String!
) {
  createFeedbackPost(
    category: $category,
    description: $description,
    tagIds: $tagIds,
    title: $title
  ) {
    errors
    feedbackPost {
      ...FeedbackPostFragment
    }
  }
}
Variables
{
  "category": "xyz789",
  "description": "abc123",
  "tagIds": [4],
  "title": "xyz789"
}
Response
{
  "data": {
    "createFeedbackPost": {
      "errors": ["xyz789"],
      "feedbackPost": FeedbackPost
    }
  }
}

createFeedbackTag

Description

Creates a new feedback tag (admin only).

Response

Returns a CreateFeedbackTagPayload!

Arguments
Name Description
description - String Optional description of the tag.
name - String! Display name of the tag.

Example

Query
mutation createFeedbackTag(
  $description: String,
  $name: String!
) {
  createFeedbackTag(
    description: $description,
    name: $name
  ) {
    errors
    feedbackTag {
      ...FeedbackTagFragment
    }
  }
}
Variables
{
  "description": "xyz789",
  "name": "abc123"
}
Response
{
  "data": {
    "createFeedbackTag": {
      "errors": ["xyz789"],
      "feedbackTag": FeedbackTag
    }
  }
}

createPact

Description

Creates a new Pact (forming) with the creator joined. Behind pacts_enabled.

Response

Returns a CreatePactPayload!

Arguments
Name Description
daysPerWeek - Int
graceDays - Int
lengthDays - Int!
missPolicy - String!
name - String!
rules - [PactRuleInput!]!
shape - String!
stakes - String
startsOn - ISO8601Date!
templateKey - String
totalTarget - Float
totalUnit - String
visibility - String

Example

Query
mutation createPact(
  $daysPerWeek: Int,
  $graceDays: Int,
  $lengthDays: Int!,
  $missPolicy: String!,
  $name: String!,
  $rules: [PactRuleInput!]!,
  $shape: String!,
  $stakes: String,
  $startsOn: ISO8601Date!,
  $templateKey: String,
  $totalTarget: Float,
  $totalUnit: String,
  $visibility: String
) {
  createPact(
    daysPerWeek: $daysPerWeek,
    graceDays: $graceDays,
    lengthDays: $lengthDays,
    missPolicy: $missPolicy,
    name: $name,
    rules: $rules,
    shape: $shape,
    stakes: $stakes,
    startsOn: $startsOn,
    templateKey: $templateKey,
    totalTarget: $totalTarget,
    totalUnit: $totalUnit,
    visibility: $visibility
  ) {
    errors
    pact {
      ...PactFragment
    }
  }
}
Variables
{
  "daysPerWeek": 123,
  "graceDays": 987,
  "lengthDays": 987,
  "missPolicy": "abc123",
  "name": "xyz789",
  "rules": [PactRuleInput],
  "shape": "abc123",
  "stakes": "abc123",
  "startsOn": ISO8601Date,
  "templateKey": "xyz789",
  "totalTarget": 123.45,
  "totalUnit": "abc123",
  "visibility": "xyz789"
}
Response
{
  "data": {
    "createPact": {
      "errors": ["xyz789"],
      "pact": Pact
    }
  }
}

createSeasonalEvent

Description

Admin only. Creates a platform-wide seasonal event.

Response

Returns a CreateSeasonalEventPayload!

Arguments
Name Description
badgeIcon - String!
badgeName - String!
description - String
endDate - ISO8601Date!
name - String!
slug - String!
startDate - ISO8601Date!
targetGoalCount - Int

Example

Query
mutation createSeasonalEvent(
  $badgeIcon: String!,
  $badgeName: String!,
  $description: String,
  $endDate: ISO8601Date!,
  $name: String!,
  $slug: String!,
  $startDate: ISO8601Date!,
  $targetGoalCount: Int
) {
  createSeasonalEvent(
    badgeIcon: $badgeIcon,
    badgeName: $badgeName,
    description: $description,
    endDate: $endDate,
    name: $name,
    slug: $slug,
    startDate: $startDate,
    targetGoalCount: $targetGoalCount
  ) {
    errors
    seasonalEvent {
      ...SeasonalEventFragment
    }
  }
}
Variables
{
  "badgeIcon": "xyz789",
  "badgeName": "xyz789",
  "description": "abc123",
  "endDate": ISO8601Date,
  "name": "xyz789",
  "slug": "xyz789",
  "startDate": ISO8601Date,
  "targetGoalCount": 987
}
Response
{
  "data": {
    "createSeasonalEvent": {
      "errors": ["xyz789"],
      "seasonalEvent": SeasonalEvent
    }
  }
}

createSubCommunity

Description

Owner/Admin-only. Creates a new sub-community (room) scoped to the team.

Response

Returns a CreateSubCommunityPayload!

Arguments
Name Description
description - String
icon - String
joinPolicy - String
leadMembershipId - String
makeDefault - Boolean
name - String!
teamId - String!

Example

Query
mutation createSubCommunity(
  $description: String,
  $icon: String,
  $joinPolicy: String,
  $leadMembershipId: String,
  $makeDefault: Boolean,
  $name: String!,
  $teamId: String!
) {
  createSubCommunity(
    description: $description,
    icon: $icon,
    joinPolicy: $joinPolicy,
    leadMembershipId: $leadMembershipId,
    makeDefault: $makeDefault,
    name: $name,
    teamId: $teamId
  ) {
    community {
      ...CommunityFragment
    }
    errors
    teamReadOnly
  }
}
Variables
{
  "description": "xyz789",
  "icon": "xyz789",
  "joinPolicy": "xyz789",
  "leadMembershipId": "abc123",
  "makeDefault": true,
  "name": "abc123",
  "teamId": "abc123"
}
Response
{
  "data": {
    "createSubCommunity": {
      "community": Community,
      "errors": ["xyz789"],
      "teamReadOnly": true
    }
  }
}

createTeamInvite

Description

Owner/Admin-only. Creates a link (and optionally email-targeted) invite for a team.

Response

Returns a CreateTeamInvitePayload!

Arguments
Name Description
email - String
preselectedCommunityIds - [String!]
teamId - String!
teamRole - String

Example

Query
mutation createTeamInvite(
  $email: String,
  $preselectedCommunityIds: [String!],
  $teamId: String!,
  $teamRole: String
) {
  createTeamInvite(
    email: $email,
    preselectedCommunityIds: $preselectedCommunityIds,
    teamId: $teamId,
    teamRole: $teamRole
  ) {
    errors
    joinUrl
    teamInvite {
      ...TeamInviteFragment
    }
    teamReadOnly
  }
}
Variables
{
  "email": "xyz789",
  "preselectedCommunityIds": ["abc123"],
  "teamId": "abc123",
  "teamRole": "xyz789"
}
Response
{
  "data": {
    "createTeamInvite": {
      "errors": ["xyz789"],
      "joinUrl": "abc123",
      "teamInvite": TeamInvite,
      "teamReadOnly": true
    }
  }
}

decideHeadCoachAction

Description

Approve or decline an irreversible or destructive action the Head Coach staged. This is the only way a staged action runs. Re-checks role, expiry, reason and typed count; destructive actions also need a step-up token (StepUpToken header). Super-admin only, behind the head_coach_enabled kill switch.

Response

Returns a DecideHeadCoachActionPayload!

Arguments
Name Description
actionId - ID! public_id of the staged Head Coach action.
decision - String! approve | reject.
reason - String Why. Required to approve destructive actions.
typedCount - Int The affected count, typed back, for actions touching 21 or more items.

Example

Query
mutation decideHeadCoachAction(
  $actionId: ID!,
  $decision: String!,
  $reason: String,
  $typedCount: Int
) {
  decideHeadCoachAction(
    actionId: $actionId,
    decision: $decision,
    reason: $reason,
    typedCount: $typedCount
  ) {
    action {
      ...HeadCoachActionFragment
    }
    errors
    success
  }
}
Variables
{
  "actionId": 4,
  "decision": "xyz789",
  "reason": "xyz789",
  "typedCount": 987
}
Response
{
  "data": {
    "decideHeadCoachAction": {
      "action": HeadCoachAction,
      "errors": ["abc123"],
      "success": false
    }
  }
}

declineAllyRequest

Description

Declines a pending ally request.

Response

Returns a DeclineAllyRequestPayload!

Arguments
Name Description
requestId - ID! public_id of the UserAlly record (the pending request) to decline.

Example

Query
mutation declineAllyRequest($requestId: ID!) {
  declineAllyRequest(requestId: $requestId) {
    errors
    success
  }
}
Variables
{"requestId": "4"}
Response
{
  "data": {
    "declineAllyRequest": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

declineGoalSuccessor

Description

Records a decline of a successor offer (v4.113 D6). CELEBRATION leaves the quiet card eligible; CARD closes the offer for good.

Response

Returns a DeclineGoalSuccessorPayload!

Arguments
Name Description
goalId - ID! public_id of the goal whose offer is being declined.
surface - SuccessorOfferDeclineSurfaceEnum!

Example

Query
mutation declineGoalSuccessor(
  $goalId: ID!,
  $surface: SuccessorOfferDeclineSurfaceEnum!
) {
  declineGoalSuccessor(
    goalId: $goalId,
    surface: $surface
  ) {
    errorCode
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": 4, "surface": "CARD"}
Response
{
  "data": {
    "declineGoalSuccessor": {
      "errorCode": "abc123",
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

declinePartnerRequest

Description

Declines a pending accountability partner request from an ally.

Response

Returns a DeclinePartnerRequestPayload!

Arguments
Name Description
allyPublicId - ID! public_id of the ally whose partner request to decline.

Example

Query
mutation declinePartnerRequest($allyPublicId: ID!) {
  declinePartnerRequest(allyPublicId: $allyPublicId) {
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"allyPublicId": 4}
Response
{
  "data": {
    "declinePartnerRequest": {
      "errors": ["abc123"],
      "userAlly": UserAlly
    }
  }
}

deferCoachPicker

Description

Records "Decide later" on the empty-dashboard Coach picker, across devices.

Response

Returns a DeferCoachPickerPayload!

Example

Query
mutation deferCoachPicker {
  deferCoachPicker {
    errors
    success
  }
}
Response
{
  "data": {
    "deferCoachPicker": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

deleteAdminUserSegment

Description

Delete one of the caller's own saved user segments. Admin roles that manage user segments only. Audit-logged.

Response

Returns a DeleteAdminUserSegmentPayload!

Arguments
Name Description
id - ID! public_id of the segment.

Example

Query
mutation deleteAdminUserSegment($id: ID!) {
  deleteAdminUserSegment(id: $id) {
    errors
    success
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteAdminUserSegment": {
      "errors": ["abc123"],
      "success": false
    }
  }
}

deleteDemoEntity

Description

Delete a demo user/goal/community. super_admin only.

Response

Returns a DeleteDemoEntityPayload!

Arguments
Name Description
entityId - ID!
entityType - String!

Example

Query
mutation deleteDemoEntity(
  $entityId: ID!,
  $entityType: String!
) {
  deleteDemoEntity(
    entityId: $entityId,
    entityType: $entityType
  ) {
    errors
    success
  }
}
Variables
{
  "entityId": "4",
  "entityType": "abc123"
}
Response
{
  "data": {
    "deleteDemoEntity": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

deleteGoalIdea

Description

Deletes a parked goal idea for the authenticated user. Immediate, no undo.

Response

Returns a DeleteGoalIdeaPayload!

Arguments
Name Description
id - ID! public_id of the GoalIdea to delete.

Example

Query
mutation deleteGoalIdea($id: ID!) {
  deleteGoalIdea(id: $id) {
    errors
    success
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteGoalIdea": {
      "errors": ["abc123"],
      "success": true
    }
  }
}

deleteNotification

Description

Permanently deletes a notification record for the authenticated user.

Response

Returns a DeleteNotificationPayload!

Arguments
Name Description
id - ID! The public ID of the notification to delete.

Example

Query
mutation deleteNotification($id: ID!) {
  deleteNotification(id: $id) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteNotification": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

deleteOwnAccount

Description

Permanently deletes the authenticated user account and all personal data.

Response

Returns a DeleteOwnAccountPayload!

Arguments
Name Description
appleAuthorizationCode - String Fresh Sign in with Apple code, to revoke Apple tokens.
appleReauthSupported - Boolean True when the client can collect an Apple authorization code (iOS). Default = false

Example

Query
mutation deleteOwnAccount(
  $appleAuthorizationCode: String,
  $appleReauthSupported: Boolean
) {
  deleteOwnAccount(
    appleAuthorizationCode: $appleAuthorizationCode,
    appleReauthSupported: $appleReauthSupported
  ) {
    appleAuthorizationRequired
    appleManualRevokeSuggested
    errors
    success
  }
}
Variables
{
  "appleAuthorizationCode": "xyz789",
  "appleReauthSupported": false
}
Response
{
  "data": {
    "deleteOwnAccount": {
      "appleAuthorizationRequired": false,
      "appleManualRevokeSuggested": false,
      "errors": ["xyz789"],
      "success": true
    }
  }
}

disconnectIntegrationConnection

Description

Disconnects a connected provider. Past check-ins stay; future activity stops syncing.

Arguments
Name Description
integrationConnectionId - ID! public_id of the connection to disconnect.

Example

Query
mutation disconnectIntegrationConnection($integrationConnectionId: ID!) {
  disconnectIntegrationConnection(integrationConnectionId: $integrationConnectionId) {
    errors
    integrationConnection {
      ...IntegrationConnectionFragment
    }
  }
}
Variables
{"integrationConnectionId": 4}
Response
{
  "data": {
    "disconnectIntegrationConnection": {
      "errors": ["abc123"],
      "integrationConnection": IntegrationConnection
    }
  }
}

dismissAiAutonomyOffer

Description

Not now: sets the offer aside without changing the agent's autonomy. Idempotent.

Response

Returns a DismissAiAutonomyOfferPayload!

Arguments
Name Description
id - String!

Example

Query
mutation dismissAiAutonomyOffer($id: String!) {
  dismissAiAutonomyOffer(id: $id) {
    errors
    offer {
      ...AiAutonomyOfferFragment
    }
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "dismissAiAutonomyOffer": {
      "errors": ["abc123"],
      "offer": AiAutonomyOffer
    }
  }
}

dismissCoachProposal

Description

Close a Coach proposal without applying it (Not now), or record that the user saved the goal form instead.

Response

Returns a DismissCoachProposalPayload!

Arguments
Name Description
id - ID! public_id of the Coach proposal.
reason - CoachProposalDismissReasonEnum DISMISSED (default) or APPLIED_VIA_FORM. Default = DISMISSED

Example

Query
mutation dismissCoachProposal(
  $id: ID!,
  $reason: CoachProposalDismissReasonEnum
) {
  dismissCoachProposal(
    id: $id,
    reason: $reason
  ) {
    coachProposal {
      ...CoachProposalFragment
    }
    errors
  }
}
Variables
{"id": 4, "reason": "DISMISSED"}
Response
{
  "data": {
    "dismissCoachProposal": {
      "coachProposal": CoachProposal,
      "errors": ["xyz789"]
    }
  }
}

dismissDashboardHint

Description

Permanently dismisses a v4.15 dashboard hierarchy one-time surface (migration note or a relocation hint) for the authenticated user.

Response

Returns a DismissDashboardHintPayload!

Arguments
Name Description
hint - String! migration_note | relocation_community | relocation_achieve | coach_warmup | focus_intro

Example

Query
mutation dismissDashboardHint($hint: String!) {
  dismissDashboardHint(hint: $hint) {
    success
  }
}
Variables
{"hint": "abc123"}
Response
{"data": {"dismissDashboardHint": {"success": false}}}

dismissEnneagramCard

Description

Permanently dismisses the Enneagram dashboard prompt card for the authenticated user.

Response

Returns a DismissEnneagramCardPayload!

Example

Query
mutation dismissEnneagramCard {
  dismissEnneagramCard {
    success
  }
}
Response
{"data": {"dismissEnneagramCard": {"success": true}}}

dismissHabitIntegrationMapping

Description

Removes a habit mapping.

Arguments
Name Description
mappingId - ID! public_id of the mapping to dismiss.

Example

Query
mutation dismissHabitIntegrationMapping($mappingId: ID!) {
  dismissHabitIntegrationMapping(mappingId: $mappingId) {
    errors
    mapping {
      ...HabitIntegrationMappingFragment
    }
  }
}
Variables
{"mappingId": 4}
Response
{
  "data": {
    "dismissHabitIntegrationMapping": {
      "errors": ["xyz789"],
      "mapping": HabitIntegrationMapping
    }
  }
}

dismissIntegrationSuggestion

Description

Dismisses a habit -> provider suggestion ("Not now"). Permanent for this pair, server-side.

Arguments
Name Description
goalId - ID! public_id of the suggested habit.
providerSlug - String! Slug of the suggested provider.

Example

Query
mutation dismissIntegrationSuggestion(
  $goalId: ID!,
  $providerSlug: String!
) {
  dismissIntegrationSuggestion(
    goalId: $goalId,
    providerSlug: $providerSlug
  ) {
    errors
  }
}
Variables
{"goalId": 4, "providerSlug": "abc123"}
Response
{
  "data": {
    "dismissIntegrationSuggestion": {
      "errors": ["abc123"]
    }
  }
}

dismissPactRestart

Description

Dismisses the current user's restart banner (D17 gap 4) without ticking anything.

Response

Returns a DismissPactRestartPayload!

Arguments
Name Description
pactId - ID!

Example

Query
mutation dismissPactRestart($pactId: ID!) {
  dismissPactRestart(pactId: $pactId) {
    errors
    pact {
      ...PactFragment
    }
  }
}
Variables
{"pactId": 4}
Response
{
  "data": {
    "dismissPactRestart": {
      "errors": ["abc123"],
      "pact": Pact
    }
  }
}

dismissPracticeInvite

Description

Dismisses the Today zero-habit invitation for 7 days, across devices (v4.93 Phase 4).

Response

Returns a DismissPracticeInvitePayload!

Example

Query
mutation dismissPracticeInvite {
  dismissPracticeInvite {
    errors
    success
  }
}
Response
{
  "data": {
    "dismissPracticeInvite": {
      "errors": ["xyz789"],
      "success": false
    }
  }
}

editHabitIntegrationMapping

Description

Re-points an existing habit mapping at a different habit.

Arguments
Name Description
goalId - ID! public_id of the new habit to map to.
mappingId - ID! public_id of the mapping to edit.

Example

Query
mutation editHabitIntegrationMapping(
  $goalId: ID!,
  $mappingId: ID!
) {
  editHabitIntegrationMapping(
    goalId: $goalId,
    mappingId: $mappingId
  ) {
    errors
    mapping {
      ...HabitIntegrationMappingFragment
    }
  }
}
Variables
{
  "goalId": "4",
  "mappingId": "4"
}
Response
{
  "data": {
    "editHabitIntegrationMapping": {
      "errors": ["abc123"],
      "mapping": HabitIntegrationMapping
    }
  }
}

encourage

Description

Gives an encouragement 🙌 on a goal update, a goal, or (via toUserId) a person — resolved to their most recent visible goal. Exactly one target. Repeating the same emoji on an already-encouraged event is a no-op; a different emoji swaps it (undo is withdrawEncouragement). A goal-level encouragement is capped at one per giver per server day.

Response

Returns an EncouragePayload!

Arguments
Name Description
emoji - String Unicode emoji from the allowed set. Defaults to 🙌 when omitted.
goalEventId - ID public_id of the goal event to encourage.
goalId - ID public_id of the goal to encourage.
toUserId - ID public_id of a person to encourage — resolves to their most recent visible goal.

Example

Query
mutation encourage(
  $emoji: String,
  $goalEventId: ID,
  $goalId: ID,
  $toUserId: ID
) {
  encourage(
    emoji: $emoji,
    goalEventId: $goalEventId,
    goalId: $goalId,
    toUserId: $toUserId
  ) {
    alreadyEncouragedToday
    celebration {
      ...EncouragementCelebrationFragment
    }
    encouragement {
      ...EncouragementFragment
    }
    errors
  }
}
Variables
{
  "emoji": "xyz789",
  "goalEventId": "4",
  "goalId": 4,
  "toUserId": 4
}
Response
{
  "data": {
    "encourage": {
      "alreadyEncouragedToday": false,
      "celebration": EncouragementCelebration,
      "encouragement": Encouragement,
      "errors": ["abc123"]
    }
  }
}

endPartnership

Description

Ends the current accountability partnership with an ally.

Response

Returns an EndPartnershipPayload!

Arguments
Name Description
allyPublicId - ID! public_id of the accountability partner to end partnership with.

Example

Query
mutation endPartnership($allyPublicId: ID!) {
  endPartnership(allyPublicId: $allyPublicId) {
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"allyPublicId": 4}
Response
{
  "data": {
    "endPartnership": {
      "errors": ["xyz789"],
      "userAlly": UserAlly
    }
  }
}

enqueueClear

Description

Enqueues a full demo-data clear. super_admin only.

Response

Returns an EnqueueClearPayload!

Example

Query
mutation enqueueClear {
  enqueueClear {
    errors
    jobId
  }
}
Response
{
  "data": {
    "enqueueClear": {
      "errors": ["abc123"],
      "jobId": "abc123"
    }
  }
}

enqueueReseed

Description

Enqueues a full demo-data reseed. super_admin only.

Response

Returns an EnqueueReseedPayload!

Example

Query
mutation enqueueReseed {
  enqueueReseed {
    errors
    jobId
  }
}
Response
{
  "data": {
    "enqueueReseed": {
      "errors": ["xyz789"],
      "jobId": "abc123"
    }
  }
}

enqueueScopeReset

Description

Enqueues a scope reset for a single demo domain. super_admin only.

Response

Returns an EnqueueScopeResetPayload!

Arguments
Name Description
scope - String!

Example

Query
mutation enqueueScopeReset($scope: String!) {
  enqueueScopeReset(scope: $scope) {
    errors
    jobId
    scope
  }
}
Variables
{"scope": "abc123"}
Response
{
  "data": {
    "enqueueScopeReset": {
      "errors": ["abc123"],
      "jobId": "abc123",
      "scope": "xyz789"
    }
  }
}

ensureTodaysCoachMessage

Description

Ensures a coach message exists for the user today, generating one via AI on the first daily call.

Response

Returns an EnsureTodaysCoachMessagePayload!

Example

Query
mutation ensureTodaysCoachMessage {
  ensureTodaysCoachMessage {
    generated
    insight
  }
}
Response
{
  "data": {
    "ensureTodaysCoachMessage": {
      "generated": false,
      "insight": "abc123"
    }
  }
}

executeGdprDeletion

Description

Runs the GDPR deletion cascade for a request. super_admin + step-up required.

Response

Returns an ExecuteDeletionPayload!

Arguments
Name Description
publicId - String!

Example

Query
mutation executeGdprDeletion($publicId: String!) {
  executeGdprDeletion(publicId: $publicId) {
    errors
    gdprRequest {
      ...GdprRequestFragment
    }
  }
}
Variables
{"publicId": "xyz789"}
Response
{
  "data": {
    "executeGdprDeletion": {
      "errors": ["xyz789"],
      "gdprRequest": GdprRequest
    }
  }
}

executeGdprExport

Description

Enqueues the export build job for a GDPR request. super_admin or support only.

Response

Returns an ExecuteExportPayload!

Arguments
Name Description
publicId - String!

Example

Query
mutation executeGdprExport($publicId: String!) {
  executeGdprExport(publicId: $publicId) {
    errors
    gdprRequest {
      ...GdprRequestFragment
    }
  }
}
Variables
{"publicId": "xyz789"}
Response
{
  "data": {
    "executeGdprExport": {
      "errors": ["xyz789"],
      "gdprRequest": GdprRequest
    }
  }
}

exportTeamActivityCsv

Description

Owner/Admin-only. Returns the team activity CSV inline for the given period. Built in memory and never stored. Columns are username, join date, last-active day, team-goal contributions, challenge counts and team points — never real name or email.

Response

Returns an ExportTeamActivityCsvPayload!

Arguments
Name Description
period - String! Either "weekly" or "monthly".
teamId - String! Public ID of the team to export.

Example

Query
mutation exportTeamActivityCsv(
  $period: String!,
  $teamId: String!
) {
  exportTeamActivityCsv(
    period: $period,
    teamId: $teamId
  ) {
    csv
    errors
  }
}
Variables
{
  "period": "xyz789",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "exportTeamActivityCsv": {
      "csv": "abc123",
      "errors": ["abc123"]
    }
  }
}

followCommunity

Description

Follows a community to receive updates without becoming a full member.

Response

Returns a FollowCommunityPayload!

Arguments
Name Description
communityId - ID! The public ID of the community to follow.
userId - ID! The public ID of the user following the community.

Example

Query
mutation followCommunity(
  $communityId: ID!,
  $userId: ID!
) {
  followCommunity(
    communityId: $communityId,
    userId: $userId
  ) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"communityId": "4", "userId": 4}
Response
{
  "data": {
    "followCommunity": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

generateGoalDraft

Description

Uses AI to draft a complete goal (title, category, kind, target date, why, milestones) from a freeform idea.

Response

Returns a GenerateGoalDraftPayload!

Arguments
Name Description
allowClarifier - Boolean When true, a too-vague idea may return a clarifier instead of a draft (v4.109). Legacy callers (omitted) always get a draft, matching the pre-v4.109 shape. Default = false
clarifierAnswer - String The user's answer to a prior clarifier. Forces a draft — never a second clarifier (v4.109).
idea - String! The user's freeform sentence describing what they want to achieve.
persona - String Coach persona key (e.g. "captain") to draft in. Unknown keys are ignored; omitted uses the saved coaching preference (v4.109).

Example

Query
mutation generateGoalDraft(
  $allowClarifier: Boolean,
  $clarifierAnswer: String,
  $idea: String!,
  $persona: String
) {
  generateGoalDraft(
    allowClarifier: $allowClarifier,
    clarifierAnswer: $clarifierAnswer,
    idea: $idea,
    persona: $persona
  ) {
    aiRequest {
      ...AiRequestFragment
    }
    clarifier {
      ...GoalDraftClarifierFragment
    }
    draft {
      ...GoalDraftFragment
    }
  }
}
Variables
{
  "allowClarifier": false,
  "clarifierAnswer": "xyz789",
  "idea": "abc123",
  "persona": "abc123"
}
Response
{
  "data": {
    "generateGoalDraft": {
      "aiRequest": AiRequest,
      "clarifier": GoalDraftClarifier,
      "draft": GoalDraft
    }
  }
}

generateMilestones

Description

Uses AI to generate a suggested list of milestone sub-goals for a given goal.

Response

Returns a GenerateMilestonesPayload!

Arguments
Name Description
goalContext - String Optional additional context about the goal (e.g. timeframe, current progress, constraints) to improve milestone relevance.
goalName - String! The name or title of the goal for which milestones should be generated.

Example

Query
mutation generateMilestones(
  $goalContext: String,
  $goalName: String!
) {
  generateMilestones(
    goalContext: $goalContext,
    goalName: $goalName
  ) {
    aiRequest {
      ...AiRequestFragment
    }
    milestones
  }
}
Variables
{
  "goalContext": "xyz789",
  "goalName": "abc123"
}
Response
{
  "data": {
    "generateMilestones": {
      "aiRequest": AiRequest,
      "milestones": ["xyz789"]
    }
  }
}

getAdvice

Description

Uses AI to provide personalized advice and tips for making progress on a goal.

Response

Returns a GetAdvicePayload!

Arguments
Name Description
conversationGoalId - String public_id of the goal whose CoachConversation this turn is sent into (OBJ-6511). Omit/null for the general conversation, independent of goalId.
goalId - String public_id of the goal the user is currently viewing, if any.
page - String! The page/context from which the user is asking for advice.
userMessage - String! The user's question or message to the coach.

Example

Query
mutation getAdvice(
  $conversationGoalId: String,
  $goalId: String,
  $page: String!,
  $userMessage: String!
) {
  getAdvice(
    conversationGoalId: $conversationGoalId,
    goalId: $goalId,
    page: $page,
    userMessage: $userMessage
  ) {
    advice
    aiRequest {
      ...AiRequestFragment
    }
    guideCitations {
      ...GuideCitationFragment
    }
    suggestedActions {
      ...CoachActionFragment
    }
  }
}
Variables
{
  "conversationGoalId": "abc123",
  "goalId": "xyz789",
  "page": "abc123",
  "userMessage": "xyz789"
}
Response
{
  "data": {
    "getAdvice": {
      "advice": "xyz789",
      "aiRequest": AiRequest,
      "guideCitations": [GuideCitation],
      "suggestedActions": [CoachAction]
    }
  }
}

getBillingPortalUrl

Description

Returns a Stripe Billing Portal URL for managing the Supporter subscription.

Response

Returns a GetBillingPortalUrlPayload!

Arguments
Name Description
returnUrl - String! URL to redirect back to after the user leaves the portal.

Example

Query
mutation getBillingPortalUrl($returnUrl: String!) {
  getBillingPortalUrl(returnUrl: $returnUrl) {
    errors
    portalUrl
  }
}
Variables
{"returnUrl": "abc123"}
Response
{
  "data": {
    "getBillingPortalUrl": {
      "errors": ["xyz789"],
      "portalUrl": "abc123"
    }
  }
}

grantAchievementDebug

Description

Debug/seed-only: grants a badge to the current user. Not available in production.

Response

Returns a GrantAchievementDebugPayload!

Arguments
Name Description
achievementKey - String! Badge key from the achievement catalog to grant to the current user.

Example

Query
mutation grantAchievementDebug($achievementKey: String!) {
  grantAchievementDebug(achievementKey: $achievementKey) {
    errors
    success
  }
}
Variables
{"achievementKey": "xyz789"}
Response
{
  "data": {
    "grantAchievementDebug": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

inviteAllyToCommunity

Description

Invites an accepted ally to join a community the current user is a member of.

Response

Returns an InviteAllyToCommunityPayload!

Arguments
Name Description
allyPublicId - ID! public_id of the ally to invite.
communityPublicId - ID! public_id of the community to invite the ally to.

Example

Query
mutation inviteAllyToCommunity(
  $allyPublicId: ID!,
  $communityPublicId: ID!
) {
  inviteAllyToCommunity(
    allyPublicId: $allyPublicId,
    communityPublicId: $communityPublicId
  ) {
    alreadyInvited
    errors
    success
  }
}
Variables
{
  "allyPublicId": "4",
  "communityPublicId": "4"
}
Response
{
  "data": {
    "inviteAllyToCommunity": {
      "alreadyInvited": true,
      "errors": ["xyz789"],
      "success": true
    }
  }
}

inviteToPact

Description

Invites an accepted ally of the Pact creator to join. D5 ally/block checks.

Response

Returns an InviteToPactPayload!

Arguments
Name Description
inviteeId - ID!
pactId - ID!

Example

Query
mutation inviteToPact(
  $inviteeId: ID!,
  $pactId: ID!
) {
  inviteToPact(
    inviteeId: $inviteeId,
    pactId: $pactId
  ) {
    errors
    pact {
      ...PactFragment
    }
    pactMembership {
      ...PactMembershipFragment
    }
  }
}
Variables
{"inviteeId": 4, "pactId": 4}
Response
{
  "data": {
    "inviteToPact": {
      "errors": ["xyz789"],
      "pact": Pact,
      "pactMembership": PactMembership
    }
  }
}

joinCommunity

Description

Joins the authenticated user to an existing community.

Response

Returns a JoinCommunityPayload!

Arguments
Name Description
communityId - ID! The public ID of the community to join.

Example

Query
mutation joinCommunity($communityId: ID!) {
  joinCommunity(communityId: $communityId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"communityId": "4"}
Response
{
  "data": {
    "joinCommunity": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

joinCommunityChallenge

Description

Joins the authenticated user to an active community challenge.

Response

Returns a JoinCommunityChallengePayload!

Arguments
Name Description
communityChallengeId - ID! public_id of the challenge to join.

Example

Query
mutation joinCommunityChallenge($communityChallengeId: ID!) {
  joinCommunityChallenge(communityChallengeId: $communityChallengeId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"communityChallengeId": 4}
Response
{
  "data": {
    "joinCommunityChallenge": {
      "errors": ["abc123"],
      "result": Result
    }
  }
}

joinSeasonalEvent

Description

Joins the authenticated user to an active seasonal event.

Response

Returns a JoinSeasonalEventPayload!

Arguments
Name Description
seasonalEventId - ID! public_id of the event to join.

Example

Query
mutation joinSeasonalEvent($seasonalEventId: ID!) {
  joinSeasonalEvent(seasonalEventId: $seasonalEventId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"seasonalEventId": "4"}
Response
{
  "data": {
    "joinSeasonalEvent": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

joinSubCommunity

Description

Any team member may join an open sub-community.

Response

Returns a JoinSubCommunityPayload!

Arguments
Name Description
communityId - String!
teamId - String!

Example

Query
mutation joinSubCommunity(
  $communityId: String!,
  $teamId: String!
) {
  joinSubCommunity(
    communityId: $communityId,
    teamId: $teamId
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "communityId": "xyz789",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "joinSubCommunity": {
      "community": Community,
      "errors": ["abc123"]
    }
  }
}

leaveCommunity

Description

Removes the authenticated user from a community they are a member of.

Response

Returns a LeaveCommunityPayload!

Arguments
Name Description
communityId - ID! The public ID of the community to leave.
userId - ID! The public ID of the user leaving the community.

Example

Query
mutation leaveCommunity(
  $communityId: ID!,
  $userId: ID!
) {
  leaveCommunity(
    communityId: $communityId,
    userId: $userId
  ) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{
  "communityId": "4",
  "userId": "4"
}
Response
{
  "data": {
    "leaveCommunity": {
      "errors": ["abc123"],
      "result": Result
    }
  }
}

leaveCommunityChallenge

Description

Removes the authenticated user from a community challenge.

Response

Returns a LeaveCommunityChallengePayload!

Arguments
Name Description
communityChallengeId - ID! public_id of the challenge to leave.

Example

Query
mutation leaveCommunityChallenge($communityChallengeId: ID!) {
  leaveCommunityChallenge(communityChallengeId: $communityChallengeId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"communityChallengeId": 4}
Response
{
  "data": {
    "leaveCommunityChallenge": {
      "errors": ["abc123"],
      "result": Result
    }
  }
}

leaveSeasonalEvent

Description

Removes the authenticated user from a seasonal event.

Response

Returns a LeaveSeasonalEventPayload!

Arguments
Name Description
seasonalEventId - ID! public_id of the event to leave.

Example

Query
mutation leaveSeasonalEvent($seasonalEventId: ID!) {
  leaveSeasonalEvent(seasonalEventId: $seasonalEventId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"seasonalEventId": 4}
Response
{
  "data": {
    "leaveSeasonalEvent": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

leaveSubCommunity

Description

Self-service leave for a sub-community. Idempotent; the default room cannot be left.

Response

Returns a LeaveSubCommunityPayload!

Arguments
Name Description
communityId - String!
teamId - String!

Example

Query
mutation leaveSubCommunity(
  $communityId: String!,
  $teamId: String!
) {
  leaveSubCommunity(
    communityId: $communityId,
    teamId: $teamId
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "communityId": "xyz789",
  "teamId": "abc123"
}
Response
{
  "data": {
    "leaveSubCommunity": {
      "community": Community,
      "errors": ["abc123"]
    }
  }
}

linkPactRuleSync

Description

Opts the current user's own eligible Pact rule into Strava sync (S2/S11). Owner-only and flag-gated (pact_rule_sync_enabled AND pacts_enabled).

Response

Returns a LinkPactRuleSyncPayload!

Arguments
Name Description
pactRuleId - ID!
providerActivityType - String! Strava activity_type this rule ticks on (e.g. "run").

Example

Query
mutation linkPactRuleSync(
  $pactRuleId: ID!,
  $providerActivityType: String!
) {
  linkPactRuleSync(
    pactRuleId: $pactRuleId,
    providerActivityType: $providerActivityType
  ) {
    errors
    pactRule {
      ...PactRuleFragment
    }
  }
}
Variables
{
  "pactRuleId": "4",
  "providerActivityType": "abc123"
}
Response
{
  "data": {
    "linkPactRuleSync": {
      "errors": ["xyz789"],
      "pactRule": PactRule
    }
  }
}

linkPractice

Description

Links a top-level habit (the practice) to a long goal it supports. Owner-only on both ends.

Response

Returns a LinkPracticePayload!

Arguments
Name Description
goalId - ID! public_id of the long goal the practice will support.
practiceId - ID! public_id of the habit that will become a practice.

Example

Query
mutation linkPractice(
  $goalId: ID!,
  $practiceId: ID!
) {
  linkPractice(
    goalId: $goalId,
    practiceId: $practiceId
  ) {
    errors
    goal {
      ...GoalFragment
    }
    practice {
      ...GoalFragment
    }
  }
}
Variables
{
  "goalId": "4",
  "practiceId": "4"
}
Response
{
  "data": {
    "linkPractice": {
      "errors": ["xyz789"],
      "goal": Goal,
      "practice": Goal
    }
  }
}

markReverseNudgeShown

Description

Stamps reverse_nudge.shown_at so the one-time habit-only-user Dashboard card never shows twice (v4.93 Phase 6).

Response

Returns a MarkReverseNudgeShownPayload!

Example

Query
mutation markReverseNudgeShown {
  markReverseNudgeShown {
    errors
    success
  }
}
Response
{
  "data": {
    "markReverseNudgeShown": {
      "errors": ["xyz789"],
      "success": false
    }
  }
}

markSupporterMomentShown

Description

Stamps supporter_moments.seen[key] (first write per key wins) and re-stamps last_shown_at (v4.96 Phase 1.3).

Arguments
Name Description
key - String!

Example

Query
mutation markSupporterMomentShown($key: String!) {
  markSupporterMomentShown(key: $key) {
    errors
    success
  }
}
Variables
{"key": "abc123"}
Response
{
  "data": {
    "markSupporterMomentShown": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

mintCheckInToken

Description

Mints a durable, device-scoped check-in token for background widget check-ins. Returns no token when widget_background_sync_enabled is off for the user.

Response

Returns a MintCheckInTokenPayload!

Arguments
Name Description
deviceId - String! Client-generated, stable identifier for this device.

Example

Query
mutation mintCheckInToken($deviceId: String!) {
  mintCheckInToken(deviceId: $deviceId) {
    errors
    expiresAt
    token
  }
}
Variables
{"deviceId": "abc123"}
Response
{
  "data": {
    "mintCheckInToken": {
      "errors": ["abc123"],
      "expiresAt": ISO8601DateTime,
      "token": "xyz789"
    }
  }
}

optIntoCollectiveGoal

Description

Links a personal goal to a collective goal as a contribution (GOALS-11).

Response

Returns an OptIntoCollectiveGoalPayload!

Arguments
Name Description
collectiveGoalId - String!
personalGoalId - String!

Example

Query
mutation optIntoCollectiveGoal(
  $collectiveGoalId: String!,
  $personalGoalId: String!
) {
  optIntoCollectiveGoal(
    collectiveGoalId: $collectiveGoalId,
    personalGoalId: $personalGoalId
  ) {
    collectiveGoal {
      ...CollectiveGoalFragment
    }
    errors
  }
}
Variables
{
  "collectiveGoalId": "abc123",
  "personalGoalId": "abc123"
}
Response
{
  "data": {
    "optIntoCollectiveGoal": {
      "collectiveGoal": CollectiveGoal,
      "errors": ["abc123"]
    }
  }
}

optOutOfCollectiveGoal

Description

Self-service opt-out from a collective goal (GOALS-12). Preserves contribution history — never destroys the row.

Response

Returns an OptOutOfCollectiveGoalPayload!

Arguments
Name Description
collectiveGoalId - String!

Example

Query
mutation optOutOfCollectiveGoal($collectiveGoalId: String!) {
  optOutOfCollectiveGoal(collectiveGoalId: $collectiveGoalId) {
    collectiveGoal {
      ...CollectiveGoalFragment
    }
    errors
  }
}
Variables
{"collectiveGoalId": "xyz789"}
Response
{
  "data": {
    "optOutOfCollectiveGoal": {
      "collectiveGoal": CollectiveGoal,
      "errors": ["xyz789"]
    }
  }
}

parkGoalIdeas

Description

Saves the unpicked ideas from a Ten -> One run to the authenticated user's Ideas list.

Response

Returns a ParkGoalIdeasPayload!

Arguments
Name Description
ideas - [String!]! The unpicked idea texts, up to 9 per run.

Example

Query
mutation parkGoalIdeas($ideas: [String!]!) {
  parkGoalIdeas(ideas: $ideas) {
    errors
    goalIdeas {
      ...GoalIdeaFragment
    }
    success
  }
}
Variables
{"ideas": ["xyz789"]}
Response
{
  "data": {
    "parkGoalIdeas": {
      "errors": ["abc123"],
      "goalIdeas": [GoalIdea],
      "success": false
    }
  }
}

parseChallenge

Description

Uses Coach to draft a cause challenge's fields (title, total, unit, dates, cause, URLs) from pasted text, up to 2,000 characters.

Response

Returns a ParseChallengePayload!

Arguments
Name Description
text - String! Pasted text describing the challenge (a post, article, or link).

Example

Query
mutation parseChallenge($text: String!) {
  parseChallenge(text: $text) {
    aiRequest {
      ...AiRequestFragment
    }
  }
}
Variables
{"text": "xyz789"}
Response
{"data": {"parseChallenge": {"aiRequest": AiRequest}}}

pauseAiAutopilot

Response

Returns a PauseAiAutopilotPayload!

Arguments
Name Description
autopilotId - String!

Example

Query
mutation pauseAiAutopilot($autopilotId: String!) {
  pauseAiAutopilot(autopilotId: $autopilotId) {
    autopilot {
      ...AiAutopilotFragment
    }
    errors
  }
}
Variables
{"autopilotId": "abc123"}
Response
{
  "data": {
    "pauseAiAutopilot": {
      "autopilot": AiAutopilot,
      "errors": ["xyz789"]
    }
  }
}

pauseAiEmployee

Response

Returns a PauseAiEmployeePayload!

Arguments
Name Description
active - Boolean! true to resume, false to pause
employeeId - String!

Example

Query
mutation pauseAiEmployee(
  $active: Boolean!,
  $employeeId: String!
) {
  pauseAiEmployee(
    active: $active,
    employeeId: $employeeId
  ) {
    employee {
      ...AiEmployeeFragment
    }
    errors
  }
}
Variables
{"active": true, "employeeId": "xyz789"}
Response
{
  "data": {
    "pauseAiEmployee": {
      "employee": AiEmployee,
      "errors": ["xyz789"]
    }
  }
}

pauseIntegrationConnection

Description

Pauses a connected provider — stops syncing new activity until resumed.

Arguments
Name Description
integrationConnectionId - ID! public_id of the connection to pause.

Example

Query
mutation pauseIntegrationConnection($integrationConnectionId: ID!) {
  pauseIntegrationConnection(integrationConnectionId: $integrationConnectionId) {
    errors
    integrationConnection {
      ...IntegrationConnectionFragment
    }
  }
}
Variables
{"integrationConnectionId": "4"}
Response
{
  "data": {
    "pauseIntegrationConnection": {
      "errors": ["abc123"],
      "integrationConnection": IntegrationConnection
    }
  }
}

promoteTeamMember

Description

Owner/Admin-only. Changes a team member's role. Cannot set role to owner — use transferTeamBillingOwnership for ownership transfer.

Response

Returns a PromoteTeamMemberPayload!

Arguments
Name Description
role - String!
teamId - String!
teamMembershipId - String!

Example

Query
mutation promoteTeamMember(
  $role: String!,
  $teamId: String!,
  $teamMembershipId: String!
) {
  promoteTeamMember(
    role: $role,
    teamId: $teamId,
    teamMembershipId: $teamMembershipId
  ) {
    errors
    teamMembership {
      ...TeamMembershipFragment
    }
  }
}
Variables
{
  "role": "abc123",
  "teamId": "xyz789",
  "teamMembershipId": "xyz789"
}
Response
{
  "data": {
    "promoteTeamMember": {
      "errors": ["xyz789"],
      "teamMembership": TeamMembership
    }
  }
}

reassignAiAssignment

Response

Returns a ReassignAiAssignmentPayload!

Arguments
Name Description
id - String!
ownerId - String!

Example

Query
mutation reassignAiAssignment(
  $id: String!,
  $ownerId: String!
) {
  reassignAiAssignment(
    id: $id,
    ownerId: $ownerId
  ) {
    assignment {
      ...AiAssignmentFragment
    }
    errors
  }
}
Variables
{
  "id": "xyz789",
  "ownerId": "abc123"
}
Response
{
  "data": {
    "reassignAiAssignment": {
      "assignment": AiAssignment,
      "errors": ["xyz789"]
    }
  }
}

reconfirmPactTerms

Description

"I'm still in" on the invite card's Rules changed state (D17 gap 3).

Response

Returns a ReconfirmPactTermsPayload!

Arguments
Name Description
pactId - ID!

Example

Query
mutation reconfirmPactTerms($pactId: ID!) {
  reconfirmPactTerms(pactId: $pactId) {
    errors
    pact {
      ...PactFragment
    }
    pactMembership {
      ...PactMembershipFragment
    }
  }
}
Variables
{"pactId": "4"}
Response
{
  "data": {
    "reconfirmPactTerms": {
      "errors": ["xyz789"],
      "pact": Pact,
      "pactMembership": PactMembership
    }
  }
}

recordCriticalPathPlay

Description

Records a completed Critical Path play for today. Idempotent — re-submitting returns the original play.

Response

Returns a RecordCriticalPathPlayPayload!

Arguments
Name Description
cols - Int Puzzle grid column count (5–7); used for grid-size-scoped pace comparisons.
elapsedSeconds - Int! Time taken to solve the puzzle in seconds (1–86400).
rows - Int Puzzle grid row count (5–7); used for grid-size-scoped pace comparisons.

Example

Query
mutation recordCriticalPathPlay(
  $cols: Int,
  $elapsedSeconds: Int!,
  $rows: Int
) {
  recordCriticalPathPlay(
    cols: $cols,
    elapsedSeconds: $elapsedSeconds,
    rows: $rows
  ) {
    errors
    status {
      ...CriticalPathPlayStatusFragment
    }
    stimXpEarned
  }
}
Variables
{"cols": 123, "elapsedSeconds": 123, "rows": 123}
Response
{
  "data": {
    "recordCriticalPathPlay": {
      "errors": ["abc123"],
      "status": CriticalPathPlayStatus,
      "stimXpEarned": 987
    }
  }
}

recordShare

Response

Returns a RecordSharePayload!

Arguments
Name Description
channel - String Share destination, e.g. "native", "link".
code - String v4.56 Phase 5 (REF-01) — the shareCode reserved by shareableMoment and already handed to the OS share sheet. Persisted verbatim when valid; omit to keep the legacy server-minted behavior.
kind - String! One of: badge, goal_completion, milestone, streak.
subjectPublicId - ID! public_id of the subject (or badge key for kind: badge).

Example

Query
mutation recordShare(
  $channel: String,
  $code: String,
  $kind: String!,
  $subjectPublicId: ID!
) {
  recordShare(
    channel: $channel,
    code: $code,
    kind: $kind,
    subjectPublicId: $subjectPublicId
  ) {
    errors
    shareEvent {
      ...ShareEventFragment
    }
  }
}
Variables
{
  "channel": "abc123",
  "code": "xyz789",
  "kind": "abc123",
  "subjectPublicId": "4"
}
Response
{
  "data": {
    "recordShare": {
      "errors": ["abc123"],
      "shareEvent": ShareEvent
    }
  }
}

recordUserAction

Description

Records an onboarding-funnel UserAction event from the client (METRIC-01). Allow-listed onboarding action names only.

Response

Returns a RecordUserActionPayload!

Arguments
Name Description
action - String! One of the wizard_* onboarding action names. Other UserAction enum values are rejected.
metadata - JSON Optional payload (e.g. { slideId, variantId }). Unknown top-level keys are dropped.

Example

Query
mutation recordUserAction(
  $action: String!,
  $metadata: JSON
) {
  recordUserAction(
    action: $action,
    metadata: $metadata
  ) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"action": "xyz789", "metadata": {}}
Response
{
  "data": {
    "recordUserAction": {
      "errors": ["abc123"],
      "result": Result
    }
  }
}

refineDescription

Description

Uses AI to refine or generate a compelling goal description.

Response

Returns a RefineDescriptionPayload!

Arguments
Name Description
currentDescription - String Optional existing description to improve upon.
goalName - String! The name or title of the goal.

Example

Query
mutation refineDescription(
  $currentDescription: String,
  $goalName: String!
) {
  refineDescription(
    currentDescription: $currentDescription,
    goalName: $goalName
  ) {
    aiRequest {
      ...AiRequestFragment
    }
    description
  }
}
Variables
{
  "currentDescription": "xyz789",
  "goalName": "xyz789"
}
Response
{
  "data": {
    "refineDescription": {
      "aiRequest": AiRequest,
      "description": "abc123"
    }
  }
}

refineGoal

Description

Uses AI to critique a not-yet-saved goal for specificity, a realistic target date, and right-sizing, returning up to 3 one-tap-acceptable suggestions.

Response

Returns a RefineGoalPayload!

Arguments
Name Description
categoryName - String
description - String
kindName - String
milestones - [String!] Default = []
name - String! The goal title as currently typed.
smart - Boolean Enables the measure/cadence/why SMART fields and drops "description" (v4.109). Legacy callers (omitted) keep today's shape. Default = false
targetDate - String ISO8601 target date, if set.

Example

Query
mutation refineGoal(
  $categoryName: String,
  $description: String,
  $kindName: String,
  $milestones: [String!],
  $name: String!,
  $smart: Boolean,
  $targetDate: String
) {
  refineGoal(
    categoryName: $categoryName,
    description: $description,
    kindName: $kindName,
    milestones: $milestones,
    name: $name,
    smart: $smart,
    targetDate: $targetDate
  ) {
    aiRequest {
      ...AiRequestFragment
    }
    suggestions {
      ...GoalRefinementSuggestionFragment
    }
  }
}
Variables
{
  "categoryName": "abc123",
  "description": "abc123",
  "kindName": "abc123",
  "milestones": [""],
  "name": "xyz789",
  "smart": false,
  "targetDate": "abc123"
}
Response
{
  "data": {
    "refineGoal": {
      "aiRequest": AiRequest,
      "suggestions": [GoalRefinementSuggestion]
    }
  }
}

rejectAiArtifact

Description

Rejects a pending AI artifact with a mandatory reason (minimum 10 characters).

Response

Returns a RejectAiArtifactPayload!

Arguments
Name Description
artifactId - String!
rejectionReason - String!

Example

Query
mutation rejectAiArtifact(
  $artifactId: String!,
  $rejectionReason: String!
) {
  rejectAiArtifact(
    artifactId: $artifactId,
    rejectionReason: $rejectionReason
  ) {
    artifact {
      ...AiArtifactFragment
    }
    errors
  }
}
Variables
{
  "artifactId": "abc123",
  "rejectionReason": "abc123"
}
Response
{
  "data": {
    "rejectAiArtifact": {
      "artifact": AiArtifact,
      "errors": ["abc123"]
    }
  }
}

removeAlly

Description

Removes an accepted ally relationship.

Response

Returns a RemoveAllyPayload!

Arguments
Name Description
targetUserId - ID! public_id of the ally to remove.

Example

Query
mutation removeAlly($targetUserId: ID!) {
  removeAlly(targetUserId: $targetUserId) {
    errors
    success
  }
}
Variables
{"targetUserId": "4"}
Response
{
  "data": {
    "removeAlly": {
      "errors": ["xyz789"],
      "success": false
    }
  }
}

removeTeamMember

Description

Owner/Admin-only. Removes a member: clears their sub-community memberships, anonymizes their leaderboard entries, and soft-deletes their seat. The member's personal account is untouched.

Response

Returns a RemoveTeamMemberPayload!

Arguments
Name Description
teamId - String!
teamMembershipId - String!

Example

Query
mutation removeTeamMember(
  $teamId: String!,
  $teamMembershipId: String!
) {
  removeTeamMember(
    teamId: $teamId,
    teamMembershipId: $teamMembershipId
  ) {
    errors
    teamMembership {
      ...TeamMembershipFragment
    }
  }
}
Variables
{
  "teamId": "abc123",
  "teamMembershipId": "xyz789"
}
Response
{
  "data": {
    "removeTeamMember": {
      "errors": ["xyz789"],
      "teamMembership": TeamMembership
    }
  }
}

reorderMilestones

Description

Atomically reorders a goal's milestone/roadmap steps by public_id.

Response

Returns a ReorderMilestonesPayload!

Arguments
Name Description
goalId - ID! public_id of the parent goal.
orderedMilestoneIds - [ID!]! Milestone public_ids in the desired order.

Example

Query
mutation reorderMilestones(
  $goalId: ID!,
  $orderedMilestoneIds: [ID!]!
) {
  reorderMilestones(
    goalId: $goalId,
    orderedMilestoneIds: $orderedMilestoneIds
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": "4", "orderedMilestoneIds": [4]}
Response
{
  "data": {
    "reorderMilestones": {
      "errors": ["abc123"],
      "goal": Goal
    }
  }
}

repairStreak

Description

Repairs a broken streak by charging XP and backfilling system-granted freeze completions for all missed days within the 24–48h repair window.

Response

Returns a RepairStreakPayload!

Arguments
Name Description
goalId - ID! public_id of the habit goal to repair.

Example

Query
mutation repairStreak($goalId: ID!) {
  repairStreak(goalId: $goalId) {
    errors
    goal {
      ...GoalFragment
    }
    user {
      ...UserFragment
    }
  }
}
Variables
{"goalId": "4"}
Response
{
  "data": {
    "repairStreak": {
      "errors": ["abc123"],
      "goal": Goal,
      "user": User
    }
  }
}

reportContent

Response

Returns a ReportContentPayload!

Arguments
Name Description
details - String
reason - String!
reportableId - ID!
reportableType - String!

Example

Query
mutation reportContent(
  $details: String,
  $reason: String!,
  $reportableId: ID!,
  $reportableType: String!
) {
  reportContent(
    details: $details,
    reason: $reason,
    reportableId: $reportableId,
    reportableType: $reportableType
  ) {
    contentReport {
      ...ContentReportFragment
    }
    errors
  }
}
Variables
{
  "details": "xyz789",
  "reason": "xyz789",
  "reportableId": "4",
  "reportableType": "xyz789"
}
Response
{
  "data": {
    "reportContent": {
      "contentReport": ContentReport,
      "errors": ["abc123"]
    }
  }
}

requestAiArtifactChanges

Description

Asks the agent to revise a pending artifact. The original waits as changes requested until the revision lands.

Arguments
Name Description
artifactId - String!
feedback - String! What to change. At least 10 characters.

Example

Query
mutation requestAiArtifactChanges(
  $artifactId: String!,
  $feedback: String!
) {
  requestAiArtifactChanges(
    artifactId: $artifactId,
    feedback: $feedback
  ) {
    artifact {
      ...AiArtifactFragment
    }
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{
  "artifactId": "abc123",
  "feedback": "xyz789"
}
Response
{
  "data": {
    "requestAiArtifactChanges": {
      "artifact": AiArtifact,
      "errors": ["abc123"],
      "run": AiRun
    }
  }
}

requestAiChatTaskDraft

Description

Asks the agent to draft a task from the conversation so far. Wakes the agent unless a run is already queued or running, same as any other chat message.

Response

Returns a RequestAiChatTaskDraftPayload!

Arguments
Name Description
sessionId - String!

Example

Query
mutation requestAiChatTaskDraft($sessionId: String!) {
  requestAiChatTaskDraft(sessionId: $sessionId) {
    errors
    session {
      ...AiChatSessionFragment
    }
  }
}
Variables
{"sessionId": "xyz789"}
Response
{
  "data": {
    "requestAiChatTaskDraft": {
      "errors": ["abc123"],
      "session": AiChatSession
    }
  }
}

requestDataExport

Description

Requests a GDPR data export for the authenticated user. Subject to a 24h cooldown.

Response

Returns a RequestDataExportPayload!

Example

Query
mutation requestDataExport {
  requestDataExport {
    errors
    gdprRequest {
      ...GdprRequestFragment
    }
  }
}
Response
{
  "data": {
    "requestDataExport": {
      "errors": ["abc123"],
      "gdprRequest": GdprRequest
    }
  }
}

requestMagicCode

Description

Sends a 6-character sign-in code to the given email. Always returns success to avoid leaking account existence.

Response

Returns a RequestMagicCodePayload!

Arguments
Name Description
email - String!

Example

Query
mutation requestMagicCode($email: String!) {
  requestMagicCode(email: $email) {
    challenge
    errors
    success
  }
}
Variables
{"email": "xyz789"}
Response
{
  "data": {
    "requestMagicCode": {
      "challenge": "abc123",
      "errors": ["xyz789"],
      "success": false
    }
  }
}

rerunHabitIntegrationMapping

Description

Re-scores a connection's not-yet-checked-in activities against the user's current habits.

Arguments
Name Description
integrationConnectionId - ID! public_id of the connection to re-run.

Example

Query
mutation rerunHabitIntegrationMapping($integrationConnectionId: ID!) {
  rerunHabitIntegrationMapping(integrationConnectionId: $integrationConnectionId) {
    errors
    proposals {
      ...MappingProposalFragment
    }
  }
}
Variables
{"integrationConnectionId": "4"}
Response
{
  "data": {
    "rerunHabitIntegrationMapping": {
      "errors": ["xyz789"],
      "proposals": [MappingProposal]
    }
  }
}

resetOnboarding

Description

Replaces the onboarding blob with a reset marker so the wizard re-triggers. Omit userPublicId to reset self (any authenticated user). Pass userPublicId to target another user (admin only). Idempotent.

Response

Returns a ResetOnboardingPayload!

Arguments
Name Description
userPublicId - ID Target user public ID. Admin-only. Omit to reset self.

Example

Query
mutation resetOnboarding($userPublicId: ID) {
  resetOnboarding(userPublicId: $userPublicId) {
    errors
    success
    user {
      ...UserFragment
    }
  }
}
Variables
{"userPublicId": "4"}
Response
{
  "data": {
    "resetOnboarding": {
      "errors": ["xyz789"],
      "success": true,
      "user": User
    }
  }
}

respondToPactInvite

Description

Join or decline a Pact invite.

Response

Returns a RespondToPactInvitePayload!

Arguments
Name Description
pactMembershipId - ID!
response - String! "join" or "decline".

Example

Query
mutation respondToPactInvite(
  $pactMembershipId: ID!,
  $response: String!
) {
  respondToPactInvite(
    pactMembershipId: $pactMembershipId,
    response: $response
  ) {
    errors
    pact {
      ...PactFragment
    }
    pactMembership {
      ...PactMembershipFragment
    }
  }
}
Variables
{
  "pactMembershipId": "4",
  "response": "abc123"
}
Response
{
  "data": {
    "respondToPactInvite": {
      "errors": ["xyz789"],
      "pact": Pact,
      "pactMembership": PactMembership
    }
  }
}

resumeAiAutopilot

Response

Returns a ResumeAiAutopilotPayload!

Arguments
Name Description
autopilotId - String!

Example

Query
mutation resumeAiAutopilot($autopilotId: String!) {
  resumeAiAutopilot(autopilotId: $autopilotId) {
    autopilot {
      ...AiAutopilotFragment
    }
    errors
  }
}
Variables
{"autopilotId": "abc123"}
Response
{
  "data": {
    "resumeAiAutopilot": {
      "autopilot": AiAutopilot,
      "errors": ["abc123"]
    }
  }
}

resumeIntegrationConnection

Description

Resumes a paused connection.

Arguments
Name Description
integrationConnectionId - ID! public_id of the connection to resume.

Example

Query
mutation resumeIntegrationConnection($integrationConnectionId: ID!) {
  resumeIntegrationConnection(integrationConnectionId: $integrationConnectionId) {
    errors
    integrationConnection {
      ...IntegrationConnectionFragment
    }
  }
}
Variables
{"integrationConnectionId": 4}
Response
{
  "data": {
    "resumeIntegrationConnection": {
      "errors": ["xyz789"],
      "integrationConnection": IntegrationConnection
    }
  }
}

resumeTeamSubscription

Description

Owner-only. Resumes a canceled team's subscription while it's still inside its paid period.

Response

Returns a ResumeTeamSubscriptionPayload!

Arguments
Name Description
teamId - String!

Example

Query
mutation resumeTeamSubscription($teamId: String!) {
  resumeTeamSubscription(teamId: $teamId) {
    errors
    success
  }
}
Variables
{"teamId": "xyz789"}
Response
{
  "data": {
    "resumeTeamSubscription": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

retryAiArtifact

Description

Asks the agent to try again on an auto-rejected artifact, telling it what was wrong.

Response

Returns a RetryAiArtifactPayload!

Arguments
Name Description
artifactId - String!

Example

Query
mutation retryAiArtifact($artifactId: String!) {
  retryAiArtifact(artifactId: $artifactId) {
    artifact {
      ...AiArtifactFragment
    }
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{"artifactId": "xyz789"}
Response
{
  "data": {
    "retryAiArtifact": {
      "artifact": AiArtifact,
      "errors": ["abc123"],
      "run": AiRun
    }
  }
}

retryAiArtifactDelivery

Description

Re-sends an approved social post to the channels that failed, or an approved blog article to Ghost. Channels already saved to Buffer are left alone.

Response

Returns a RetryAiArtifactDeliveryPayload!

Arguments
Name Description
artifactId - String!
channels - [String!] Just these channels. Defaults to every failed channel.

Example

Query
mutation retryAiArtifactDelivery(
  $artifactId: String!,
  $channels: [String!]
) {
  retryAiArtifactDelivery(
    artifactId: $artifactId,
    channels: $channels
  ) {
    artifact {
      ...AiArtifactFragment
    }
    errors
  }
}
Variables
{
  "artifactId": "xyz789",
  "channels": ["abc123"]
}
Response
{
  "data": {
    "retryAiArtifactDelivery": {
      "artifact": AiArtifact,
      "errors": ["abc123"]
    }
  }
}

retryAiChatMessage

Description

Re-wakes a message whose run failed or timed out. The server re-wakes every message that run consumed.

Response

Returns a RetryAiChatMessagePayload!

Arguments
Name Description
messageId - String!

Example

Query
mutation retryAiChatMessage($messageId: String!) {
  retryAiChatMessage(messageId: $messageId) {
    errors
    message {
      ...AiChatMessageFragment
    }
  }
}
Variables
{"messageId": "abc123"}
Response
{
  "data": {
    "retryAiChatMessage": {
      "errors": ["xyz789"],
      "message": AiChatMessage
    }
  }
}

retryAiRun

Description

Re-dispatches a failed run with its original agent and inputs.

Response

Returns a RetryAiRunPayload!

Arguments
Name Description
runId - String!

Example

Query
mutation retryAiRun($runId: String!) {
  retryAiRun(runId: $runId) {
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{"runId": "xyz789"}
Response
{
  "data": {
    "retryAiRun": {
      "errors": ["xyz789"],
      "run": AiRun
    }
  }
}

revertLastGoalEvent

Description

Soft-deletes the most recent progress event for a non-habit goal (Undo action). Habit goals are refused.

Response

Returns a RevertLastGoalEventPayload!

Arguments
Name Description
goalId - ID! public_id of the goal whose last event should be reverted.

Example

Query
mutation revertLastGoalEvent($goalId: ID!) {
  revertLastGoalEvent(goalId: $goalId) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": "4"}
Response
{
  "data": {
    "revertLastGoalEvent": {
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

reviewContentFlag

Response

Returns a ReviewContentFlagPayload!

Arguments
Name Description
action - String! "approve" or "reject"
flagId - String! Public ID of the content flag

Example

Query
mutation reviewContentFlag(
  $action: String!,
  $flagId: String!
) {
  reviewContentFlag(
    action: $action,
    flagId: $flagId
  ) {
    contentFlag {
      ...ContentFlagFragment
    }
    errors
  }
}
Variables
{
  "action": "xyz789",
  "flagId": "abc123"
}
Response
{
  "data": {
    "reviewContentFlag": {
      "contentFlag": ContentFlag,
      "errors": ["xyz789"]
    }
  }
}

reviewContentReport

Response

Returns a ReviewContentReportPayload!

Arguments
Name Description
action - String! "review" or "dismiss"
reportId - String! Public ID of the content report

Example

Query
mutation reviewContentReport(
  $action: String!,
  $reportId: String!
) {
  reviewContentReport(
    action: $action,
    reportId: $reportId
  ) {
    contentReport {
      ...ContentReportFragment
    }
    errors
  }
}
Variables
{
  "action": "xyz789",
  "reportId": "xyz789"
}
Response
{
  "data": {
    "reviewContentReport": {
      "contentReport": ContentReport,
      "errors": ["abc123"]
    }
  }
}

revokeAllyInvite

Description

Revokes an active accountability-partner invite. Only the inviter may revoke.

Response

Returns a RevokeAllyInvitePayload!

Arguments
Name Description
inviteToken - String! Token of the invite to revoke.

Example

Query
mutation revokeAllyInvite($inviteToken: String!) {
  revokeAllyInvite(inviteToken: $inviteToken) {
    errors
    invite {
      ...AllyInviteFragment
    }
  }
}
Variables
{"inviteToken": "xyz789"}
Response
{
  "data": {
    "revokeAllyInvite": {
      "errors": ["xyz789"],
      "invite": AllyInvite
    }
  }
}

revokeCheckInToken

Description

Revokes the check-in token(s) for a device — call on sign-out or device removal.

Response

Returns a RevokeCheckInTokenPayload!

Arguments
Name Description
deviceId - String! Identifier of the device being signed out or removed.

Example

Query
mutation revokeCheckInToken($deviceId: String!) {
  revokeCheckInToken(deviceId: $deviceId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"deviceId": "abc123"}
Response
{
  "data": {
    "revokeCheckInToken": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

revokeTeamInvite

Description

Owner/Admin-only. Revokes a pending team invite.

Response

Returns a RevokeTeamInvitePayload!

Arguments
Name Description
teamId - String!
teamInviteId - String!

Example

Query
mutation revokeTeamInvite(
  $teamId: String!,
  $teamInviteId: String!
) {
  revokeTeamInvite(
    teamId: $teamId,
    teamInviteId: $teamInviteId
  ) {
    errors
    teamInvite {
      ...TeamInviteFragment
    }
  }
}
Variables
{
  "teamId": "xyz789",
  "teamInviteId": "abc123"
}
Response
{
  "data": {
    "revokeTeamInvite": {
      "errors": ["xyz789"],
      "teamInvite": TeamInvite
    }
  }
}

runAiAutopilotNow

Response

Returns a RunAiAutopilotNowPayload!

Arguments
Name Description
autopilotId - String!

Example

Query
mutation runAiAutopilotNow($autopilotId: String!) {
  runAiAutopilotNow(autopilotId: $autopilotId) {
    autopilot {
      ...AiAutopilotFragment
    }
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{"autopilotId": "abc123"}
Response
{
  "data": {
    "runAiAutopilotNow": {
      "autopilot": AiAutopilot,
      "errors": ["xyz789"],
      "run": AiRun
    }
  }
}

seedBrokenStreakDebug

Description

Debug/seed-only: seeds a fresh habit goal with a broken 10-day streak and an open repair window for the current user, and tops up XP to cover the repair. Not available in production.

Response

Returns a SeedBrokenStreakDebugPayload!

Example

Query
mutation seedBrokenStreakDebug {
  seedBrokenStreakDebug {
    errors
    goal {
      ...GoalFragment
    }
    repairXpCost
  }
}
Response
{
  "data": {
    "seedBrokenStreakDebug": {
      "errors": ["abc123"],
      "goal": Goal,
      "repairXpCost": 987
    }
  }
}

seedIntegrationActivityDebug

Description

Debug/seed-only: seeds a fresh IntegrationActivity for the current user and surfaces it through the real auto-map pipeline (NewHabitToast). Not available in production.

Arguments
Name Description
providerSlug - String! 'strava', 'chess_com', 'github', or 'lichess'.
tier - String! 'auto' (auto-check-in tier) or 'propose' (review-band tier).

Example

Query
mutation seedIntegrationActivityDebug(
  $providerSlug: String!,
  $tier: String!
) {
  seedIntegrationActivityDebug(
    providerSlug: $providerSlug,
    tier: $tier
  ) {
    decision
    errors
    integrationActivity {
      ...IntegrationActivityFragment
    }
  }
}
Variables
{
  "providerSlug": "xyz789",
  "tier": "abc123"
}
Response
{
  "data": {
    "seedIntegrationActivityDebug": {
      "decision": "xyz789",
      "errors": ["xyz789"],
      "integrationActivity": IntegrationActivity
    }
  }
}

seedWelcomeBackDebug

Description

Debug/seed-only: lapses the current user past the Welcome Back inactivity threshold and seeds a habit goal with a real backfillable gap, so the Welcome Back interstitial becomes eligible. Not available in production.

Response

Returns a SeedWelcomeBackDebugPayload!

Example

Query
mutation seedWelcomeBackDebug {
  seedWelcomeBackDebug {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Response
{
  "data": {
    "seedWelcomeBackDebug": {
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

sendAiChatMessage

Description

Posts a message to a chat session thread. Wakes the agent unless a run is already queued or running.

Response

Returns a SendAiChatMessagePayload!

Arguments
Name Description
body - String!
sessionId - String!

Example

Query
mutation sendAiChatMessage(
  $body: String!,
  $sessionId: String!
) {
  sendAiChatMessage(
    body: $body,
    sessionId: $sessionId
  ) {
    errors
    message {
      ...AiChatMessageFragment
    }
  }
}
Variables
{
  "body": "xyz789",
  "sessionId": "abc123"
}
Response
{
  "data": {
    "sendAiChatMessage": {
      "errors": ["xyz789"],
      "message": AiChatMessage
    }
  }
}

sendAllyRequest

Description

Sends an ally request to another user.

Response

Returns a SendAllyRequestPayload!

Arguments
Name Description
targetUserId - ID! public_id of the user to send an ally request to.

Example

Query
mutation sendAllyRequest($targetUserId: ID!) {
  sendAllyRequest(targetUserId: $targetUserId) {
    alreadyRequested
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"targetUserId": 4}
Response
{
  "data": {
    "sendAllyRequest": {
      "alreadyRequested": true,
      "errors": ["abc123"],
      "userAlly": UserAlly
    }
  }
}

sendPactNudge

Description

One nudge per sender per recipient per Pact per sender-local day (D11/D20.2). ruleId can only be given under each_rule visibility.

Response

Returns a SendPactNudgePayload!

Arguments
Name Description
pactId - ID! public_id of the Pact.
recipientId - ID! public_id of the member to nudge.
ruleId - ID public_id of the rule to name (each_rule visibility only).

Example

Query
mutation sendPactNudge(
  $pactId: ID!,
  $recipientId: ID!,
  $ruleId: ID
) {
  sendPactNudge(
    pactId: $pactId,
    recipientId: $recipientId,
    ruleId: $ruleId
  ) {
    errorCode
    errors
    pact {
      ...PactFragment
    }
    success
  }
}
Variables
{
  "pactId": 4,
  "recipientId": "4",
  "ruleId": 4
}
Response
{
  "data": {
    "sendPactNudge": {
      "errorCode": "xyz789",
      "errors": ["abc123"],
      "pact": Pact,
      "success": true
    }
  }
}

sendPartnerNudge

Description

Sends a nudge notification to an accountability partner. Idempotent: one nudge per partnership per direction per day.

Response

Returns a SendPartnerNudgePayload!

Arguments
Name Description
allyPublicId - ID! public_id of the accountability partner to nudge.

Example

Query
mutation sendPartnerNudge($allyPublicId: ID!) {
  sendPartnerNudge(allyPublicId: $allyPublicId) {
    errorCode
    errors
    success
  }
}
Variables
{"allyPublicId": 4}
Response
{
  "data": {
    "sendPartnerNudge": {
      "errorCode": "xyz789",
      "errors": ["abc123"],
      "success": true
    }
  }
}

sendPartnerRequest

Description

Sends an accountability partner request to an accepted ally.

Response

Returns a SendPartnerRequestPayload!

Arguments
Name Description
allyPublicId - ID! public_id of the ally to request as accountability partner.

Example

Query
mutation sendPartnerRequest($allyPublicId: ID!) {
  sendPartnerRequest(allyPublicId: $allyPublicId) {
    errors
    userAlly {
      ...UserAllyFragment
    }
  }
}
Variables
{"allyPublicId": "4"}
Response
{
  "data": {
    "sendPartnerRequest": {
      "errors": ["abc123"],
      "userAlly": UserAlly
    }
  }
}

setCoachGoalSuggestionsPreferences

Description

Turns "Let Coach suggest goal changes" on or off for the authenticated user.

Arguments
Name Description
enabled - Boolean! Whether Coach may suggest goal changes in chat.

Example

Query
mutation setCoachGoalSuggestionsPreferences($enabled: Boolean!) {
  setCoachGoalSuggestionsPreferences(enabled: $enabled) {
    errors
    preferences {
      ...CoachGoalSuggestionsPreferencesFragment
    }
  }
}
Variables
{"enabled": true}
Response
{
  "data": {
    "setCoachGoalSuggestionsPreferences": {
      "errors": ["xyz789"],
      "preferences": CoachGoalSuggestionsPreferences
    }
  }
}

setColorTheme

Description

Sets the Supporter color theme for the authenticated user, synced across devices.

Response

Returns a SetColorThemePayload!

Arguments
Name Description
slug - String! Theme slug to activate.

Example

Query
mutation setColorTheme($slug: String!) {
  setColorTheme(slug: $slug) {
    colorTheme
    errors
  }
}
Variables
{"slug": "xyz789"}
Response
{
  "data": {
    "setColorTheme": {
      "colorTheme": "abc123",
      "errors": ["abc123"]
    }
  }
}

setCommunityEditorialSlot

Description

Admin only. Sets or clears the editorial slot for a community. Slot null unsets.

Arguments
Name Description
communityId - ID!
position - Int
slot - String

Example

Query
mutation setCommunityEditorialSlot(
  $communityId: ID!,
  $position: Int,
  $slot: String
) {
  setCommunityEditorialSlot(
    communityId: $communityId,
    position: $position,
    slot: $slot
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "communityId": 4,
  "position": 987,
  "slot": "abc123"
}
Response
{
  "data": {
    "setCommunityEditorialSlot": {
      "community": Community,
      "errors": ["xyz789"]
    }
  }
}

setCommunityEventRsvp

Description

Sets the authenticated member's RSVP ('going') on a meetup. Idempotent (D7).

Response

Returns a SetCommunityEventRsvpPayload!

Arguments
Name Description
eventId - ID! public_id of the meetup to RSVP to.
going - Boolean! Whether the viewer is going.

Example

Query
mutation setCommunityEventRsvp(
  $eventId: ID!,
  $going: Boolean!
) {
  setCommunityEventRsvp(
    eventId: $eventId,
    going: $going
  ) {
    communityEvent {
      ...CommunityEventFragment
    }
    errorCode
    errors
  }
}
Variables
{"eventId": "4", "going": true}
Response
{
  "data": {
    "setCommunityEventRsvp": {
      "communityEvent": CommunityEvent,
      "errorCode": "abc123",
      "errors": ["xyz789"]
    }
  }
}

setCommunityFeatured

Description

Admin only. Toggles whether a community is featured on the discovery page.

Response

Returns a SetCommunityFeaturedPayload!

Arguments
Name Description
communityId - ID!
featured - Boolean!

Example

Query
mutation setCommunityFeatured(
  $communityId: ID!,
  $featured: Boolean!
) {
  setCommunityFeatured(
    communityId: $communityId,
    featured: $featured
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{"communityId": "4", "featured": true}
Response
{
  "data": {
    "setCommunityFeatured": {
      "community": Community,
      "errors": ["xyz789"]
    }
  }
}

setCriticalPathActiveTheme

Description

Sets the active visual theme for the authenticated user. Theme must be unlocked.

Arguments
Name Description
theme - String! Theme key to activate.

Example

Query
mutation setCriticalPathActiveTheme($theme: String!) {
  setCriticalPathActiveTheme(theme: $theme) {
    errors
    status {
      ...StimXpStatusFragment
    }
  }
}
Variables
{"theme": "abc123"}
Response
{
  "data": {
    "setCriticalPathActiveTheme": {
      "errors": ["xyz789"],
      "status": StimXpStatus
    }
  }
}

setCriticalPathReminderPreferences

Description

Sets the daily reminder preferences for the authenticated user.

Arguments
Name Description
enabled - Boolean! Whether to enable daily Critical Path reminders.
timeOfDay - String Preferred local send time in HH:MM format (e.g. '08:00').
timezone - String IANA timezone string. Only applied when enabling reminders and user is on UTC default.

Example

Query
mutation setCriticalPathReminderPreferences(
  $enabled: Boolean!,
  $timeOfDay: String,
  $timezone: String
) {
  setCriticalPathReminderPreferences(
    enabled: $enabled,
    timeOfDay: $timeOfDay,
    timezone: $timezone
  ) {
    errors
    preferences {
      ...CriticalPathReminderPreferencesFragment
    }
  }
}
Variables
{
  "enabled": false,
  "timeOfDay": "abc123",
  "timezone": "abc123"
}
Response
{
  "data": {
    "setCriticalPathReminderPreferences": {
      "errors": ["abc123"],
      "preferences": CriticalPathReminderPreferences
    }
  }
}

setDefaultSubCommunity

Description

Owner/Admin-only. Reassigns the team's default landing room.

Response

Returns a SetDefaultSubCommunityPayload!

Arguments
Name Description
communityId - String!
teamId - String!

Example

Query
mutation setDefaultSubCommunity(
  $communityId: String!,
  $teamId: String!
) {
  setDefaultSubCommunity(
    communityId: $communityId,
    teamId: $teamId
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "communityId": "abc123",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "setDefaultSubCommunity": {
      "community": Community,
      "errors": ["xyz789"]
    }
  }
}

setGoalPartnerSharing

Description

Toggles whether a confirmed accountability partner can see a private goal. Owner-only.

Response

Returns a SetGoalPartnerSharingPayload!

Arguments
Name Description
goalId - ID! public_id of the goal to update.
sharedWithPartner - Boolean! When true, a confirmed accountability partner can see this goal.

Example

Query
mutation setGoalPartnerSharing(
  $goalId: ID!,
  $sharedWithPartner: Boolean!
) {
  setGoalPartnerSharing(
    goalId: $goalId,
    sharedWithPartner: $sharedWithPartner
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": 4, "sharedWithPartner": false}
Response
{
  "data": {
    "setGoalPartnerSharing": {
      "errors": ["abc123"],
      "goal": Goal
    }
  }
}

setGoalVisibility

Description

Sets who can see a goal: everyone, accepted allies only, or just the owner. Owner-only.

Response

Returns a SetGoalVisibilityPayload!

Arguments
Name Description
goalId - ID! public_id of the goal to update.
visibility - GoalVisibilityEnum! The new visibility tier for the goal.

Example

Query
mutation setGoalVisibility(
  $goalId: ID!,
  $visibility: GoalVisibilityEnum!
) {
  setGoalVisibility(
    goalId: $goalId,
    visibility: $visibility
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": 4, "visibility": "ALLIES"}
Response
{
  "data": {
    "setGoalVisibility": {
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

setLeaderboardVisibility

Description

Member-level opt-out from the team leaderboard (LEADERBOARD-3).

Arguments
Name Description
optedOut - Boolean!
teamId - String!

Example

Query
mutation setLeaderboardVisibility(
  $optedOut: Boolean!,
  $teamId: String!
) {
  setLeaderboardVisibility(
    optedOut: $optedOut,
    teamId: $teamId
  ) {
    errors
    optedOut
  }
}
Variables
{"optedOut": true, "teamId": "xyz789"}
Response
{
  "data": {
    "setLeaderboardVisibility": {
      "errors": ["abc123"],
      "optedOut": true
    }
  }
}

setReminderNotificationPreferences

Description

Sets the progress-nudge reminder notification preferences for the authenticated user.

Arguments
Name Description
enabled - Boolean Whether to enable progress-nudge reminders (in-app and push).
whyLineEnabled - Boolean Whether the habit check-in reminder push may include the user's own-words or fallback why-line (OBJ-5644).

Example

Query
mutation setReminderNotificationPreferences(
  $enabled: Boolean,
  $whyLineEnabled: Boolean
) {
  setReminderNotificationPreferences(
    enabled: $enabled,
    whyLineEnabled: $whyLineEnabled
  ) {
    errors
    preferences {
      ...ReminderNotificationPreferencesFragment
    }
  }
}
Variables
{"enabled": true, "whyLineEnabled": true}
Response
{
  "data": {
    "setReminderNotificationPreferences": {
      "errors": ["xyz789"],
      "preferences": ReminderNotificationPreferences
    }
  }
}

setSeasonalEventActive

Description

Admin only. Activates or deactivates a seasonal event. Events are historical once run, so this flips a flag rather than deleting the row.

Response

Returns a SetSeasonalEventActivePayload!

Arguments
Name Description
eventId - ID!
isActive - Boolean!

Example

Query
mutation setSeasonalEventActive(
  $eventId: ID!,
  $isActive: Boolean!
) {
  setSeasonalEventActive(
    eventId: $eventId,
    isActive: $isActive
  ) {
    errors
    seasonalEvent {
      ...SeasonalEventFragment
    }
  }
}
Variables
{"eventId": "4", "isActive": false}
Response
{
  "data": {
    "setSeasonalEventActive": {
      "errors": ["xyz789"],
      "seasonalEvent": SeasonalEvent
    }
  }
}

setSupporterMomentsMuted

Description

Sets or clears supporter_moments.muted_at — the "Don't show these" control (v4.96 Phase 1.3).

Arguments
Name Description
muted - Boolean!

Example

Query
mutation setSupporterMomentsMuted($muted: Boolean!) {
  setSupporterMomentsMuted(muted: $muted) {
    errors
    success
  }
}
Variables
{"muted": true}
Response
{
  "data": {
    "setSupporterMomentsMuted": {
      "errors": ["xyz789"],
      "success": false
    }
  }
}

setTeamNotificationPreferences

Description

Sets the team notification preferences for the authenticated user.

Arguments
Name Description
enabled - Boolean! Whether to enable team notifications (in-app and push).

Example

Query
mutation setTeamNotificationPreferences($enabled: Boolean!) {
  setTeamNotificationPreferences(enabled: $enabled) {
    errors
    preferences {
      ...TeamNotificationPreferencesFragment
    }
  }
}
Variables
{"enabled": false}
Response
{
  "data": {
    "setTeamNotificationPreferences": {
      "errors": ["abc123"],
      "preferences": TeamNotificationPreferences
    }
  }
}

setWeeklyDigestPreferences

Description

Sets the weekly digest email preferences for the authenticated user.

Arguments
Name Description
deliveryDay - String Day to deliver the digest: 'sun', 'sat', or 'mon'.
enabled - Boolean! Whether to enable the weekly digest email.

Example

Query
mutation setWeeklyDigestPreferences(
  $deliveryDay: String,
  $enabled: Boolean!
) {
  setWeeklyDigestPreferences(
    deliveryDay: $deliveryDay,
    enabled: $enabled
  ) {
    errors
    preferences {
      ...WeeklyDigestPreferencesFragment
    }
  }
}
Variables
{"deliveryDay": "abc123", "enabled": false}
Response
{
  "data": {
    "setWeeklyDigestPreferences": {
      "errors": ["abc123"],
      "preferences": WeeklyDigestPreferences
    }
  }
}

setWelcomeSeriesPreferences

Description

Sets the welcome series email preferences for the authenticated user.

Arguments
Name Description
enabled - Boolean! Whether to enable the welcome series email.

Example

Query
mutation setWelcomeSeriesPreferences($enabled: Boolean!) {
  setWelcomeSeriesPreferences(enabled: $enabled) {
    errors
    preferences {
      ...WelcomeSeriesPreferencesFragment
    }
  }
}
Variables
{"enabled": true}
Response
{
  "data": {
    "setWelcomeSeriesPreferences": {
      "errors": ["abc123"],
      "preferences": WelcomeSeriesPreferences
    }
  }
}

startAiChat

Description

Creates a chat session with an agent and sends its first message, in one call.

Response

Returns a StartAiChatPayload!

Arguments
Name Description
agentId - String!
body - String!

Example

Query
mutation startAiChat(
  $agentId: String!,
  $body: String!
) {
  startAiChat(
    agentId: $agentId,
    body: $body
  ) {
    errors
    session {
      ...AiChatSessionFragment
    }
  }
}
Variables
{
  "agentId": "abc123",
  "body": "abc123"
}
Response
{
  "data": {
    "startAiChat": {
      "errors": ["abc123"],
      "session": AiChatSession
    }
  }
}

startChallenge

Description

Starts a cause challenge (v4.126 D2): creates a measure goal plus its 1:1 challenge record.

Response

Returns a StartChallengePayload!

Arguments
Name Description
causeLabel - String The cause this challenge supports, max 40 chars.
donationUrl - String Where to donate for this challenge. https:// only.
endsOn - ISO8601Date! The last day of the challenge window.
organizerName - String Who is organizing this challenge, max 60 chars.
source - GoalChallengeSourceEnum How this challenge was brought in. Defaults to manual.
sourceUrl - String Where this challenge came from. https:// only.
startsOn - ISO8601Date! The first day of the challenge window.
targetAmount - Float! The challenge total (e.g. 1500).
title - String! The challenge/event name (e.g. "1,500 Squats Challenge"), max 100 chars.
unit - String! Measure unit (e.g. "squats"), max 20 chars.
visibility - GoalVisibilityEnum Who can see the goal.

Example

Query
mutation startChallenge(
  $causeLabel: String,
  $donationUrl: String,
  $endsOn: ISO8601Date!,
  $organizerName: String,
  $source: GoalChallengeSourceEnum,
  $sourceUrl: String,
  $startsOn: ISO8601Date!,
  $targetAmount: Float!,
  $title: String!,
  $unit: String!,
  $visibility: GoalVisibilityEnum
) {
  startChallenge(
    causeLabel: $causeLabel,
    donationUrl: $donationUrl,
    endsOn: $endsOn,
    organizerName: $organizerName,
    source: $source,
    sourceUrl: $sourceUrl,
    startsOn: $startsOn,
    targetAmount: $targetAmount,
    title: $title,
    unit: $unit,
    visibility: $visibility
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{
  "causeLabel": "xyz789",
  "donationUrl": "xyz789",
  "endsOn": ISO8601Date,
  "organizerName": "abc123",
  "source": "manual",
  "sourceUrl": "xyz789",
  "startsOn": ISO8601Date,
  "targetAmount": 987.65,
  "title": "abc123",
  "unit": "abc123",
  "visibility": "ALLIES"
}
Response
{
  "data": {
    "startChallenge": {
      "errors": ["abc123"],
      "goal": Goal
    }
  }
}

startHeadCoachTurn

Description

Ask Head Coach a question. Starts a new conversation unless conversationId is given. Super-admin only, behind the head_coach_enabled kill switch.

Response

Returns a StartHeadCoachTurnPayload!

Arguments
Name Description
conversationId - ID public_id of an existing conversation to continue.
pageContextJson - String Optional JSON object {route, title} describing the page the admin is on.
text - String! The question (1-4000 characters).

Example

Query
mutation startHeadCoachTurn(
  $conversationId: ID,
  $pageContextJson: String,
  $text: String!
) {
  startHeadCoachTurn(
    conversationId: $conversationId,
    pageContextJson: $pageContextJson,
    text: $text
  ) {
    conversationId
    errors
    success
    turnId
  }
}
Variables
{
  "conversationId": 4,
  "pageContextJson": "abc123",
  "text": "xyz789"
}
Response
{
  "data": {
    "startHeadCoachTurn": {
      "conversationId": 4,
      "errors": ["abc123"],
      "success": false,
      "turnId": 4
    }
  }
}

startTeamBillingPortal

Description

Owner-only. Returns a Stripe Billing Portal URL for managing the team's subscription.

Response

Returns a StartTeamBillingPortalPayload!

Arguments
Name Description
returnUrl - String! URL to redirect back to after the user leaves the portal.
teamId - String!

Example

Query
mutation startTeamBillingPortal(
  $returnUrl: String!,
  $teamId: String!
) {
  startTeamBillingPortal(
    returnUrl: $returnUrl,
    teamId: $teamId
  ) {
    errors
    portalUrl
  }
}
Variables
{
  "returnUrl": "abc123",
  "teamId": "abc123"
}
Response
{
  "data": {
    "startTeamBillingPortal": {
      "errors": ["xyz789"],
      "portalUrl": "abc123"
    }
  }
}

startTeamCheckout

Description

Opens a Stripe Checkout session for a new or re-subscribing Team.

Response

Returns a StartTeamCheckoutPayload!

Arguments
Name Description
cancelUrl - String!
planSlug - String! teams_monthly or teams_annual.
seatCount - Int Number of seats (1-200, default 5).
successUrl - String!
teamId - String Existing team public_id when re-subscribing.
teamName - String Required for a brand-new team.

Example

Query
mutation startTeamCheckout(
  $cancelUrl: String!,
  $planSlug: String!,
  $seatCount: Int,
  $successUrl: String!,
  $teamId: String,
  $teamName: String
) {
  startTeamCheckout(
    cancelUrl: $cancelUrl,
    planSlug: $planSlug,
    seatCount: $seatCount,
    successUrl: $successUrl,
    teamId: $teamId,
    teamName: $teamName
  ) {
    checkoutUrl
    errors
  }
}
Variables
{
  "cancelUrl": "abc123",
  "planSlug": "abc123",
  "seatCount": 987,
  "successUrl": "xyz789",
  "teamId": "xyz789",
  "teamName": "xyz789"
}
Response
{
  "data": {
    "startTeamCheckout": {
      "checkoutUrl": "abc123",
      "errors": ["abc123"]
    }
  }
}

stepOutOfPact

Description

Steps the current user out of a Pact, any time, with no penalty (D8). Detaches the linked goal.

Response

Returns a StepOutOfPactPayload!

Arguments
Name Description
pactId - ID!

Example

Query
mutation stepOutOfPact($pactId: ID!) {
  stepOutOfPact(pactId: $pactId) {
    errors
    pact {
      ...PactFragment
    }
    pactMembership {
      ...PactMembershipFragment
    }
  }
}
Variables
{"pactId": 4}
Response
{
  "data": {
    "stepOutOfPact": {
      "errors": ["xyz789"],
      "pact": Pact,
      "pactMembership": PactMembership
    }
  }
}

storeDeviceToken

Description

Registers a device push notification token for the authenticated user (iOS/Android).

Response

Returns a StoreDeviceTokenPayload!

Arguments
Name Description
deviceToken - ID! The push notification token issued by APNs (iOS) or FCM (Android).
platform - String The device platform. Accepted values: ios or android.

Example

Query
mutation storeDeviceToken(
  $deviceToken: ID!,
  $platform: String
) {
  storeDeviceToken(
    deviceToken: $deviceToken,
    platform: $platform
  ) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"deviceToken": 4, "platform": "abc123"}
Response
{
  "data": {
    "storeDeviceToken": {
      "errors": ["abc123"],
      "result": Result
    }
  }
}

storeFeatureTourState

Description

Writes feature-tour completion/dismissal state into UserDetail.data["feature_tours"], keyed by tour id.

Response

Returns a StoreFeatureTourStatePayload!

Arguments
Name Description
completed - Boolean Mark the tour completed (sets completed_at).
dismissed - Boolean Mark the tour dismissed/skipped.
tourId - String! Tour identifier, e.g. "dashboard-first-run".

Example

Query
mutation storeFeatureTourState(
  $completed: Boolean,
  $dismissed: Boolean,
  $tourId: String!
) {
  storeFeatureTourState(
    completed: $completed,
    dismissed: $dismissed,
    tourId: $tourId
  ) {
    errors
    featureTours
    success
  }
}
Variables
{
  "completed": false,
  "dismissed": true,
  "tourId": "xyz789"
}
Response
{
  "data": {
    "storeFeatureTourState": {
      "errors": ["abc123"],
      "featureTours": {},
      "success": false
    }
  }
}

storeOnboardingState

Description

Writes v1.8 onboarding completion or progress into UserDetail.data["onboarding"]. Accepts completed_via: "complete" | "skip" only — "backfilled" is server-only.

Response

Returns a StoreOnboardingStatePayload!

Arguments
Name Description
completedVia - OnboardingCompletedVia Set to "complete" or "skip" on wizard exit. Omit when writing progress only.
progress - OnboardingProgressInput In-flight slide progress. Cleared on wizard exit when completed_via is set.

Example

Query
mutation storeOnboardingState(
  $completedVia: OnboardingCompletedVia,
  $progress: OnboardingProgressInput
) {
  storeOnboardingState(
    completedVia: $completedVia,
    progress: $progress
  ) {
    errors
    user {
      ...UserFragment
    }
  }
}
Variables
{
  "completedVia": "complete",
  "progress": OnboardingProgressInput
}
Response
{
  "data": {
    "storeOnboardingState": {
      "errors": ["xyz789"],
      "user": User
    }
  }
}

storeUserDetails

Description

Stores or updates arbitrary metadata on the user details JSON blob (e.g. onboarding state, preferences).

Response

Returns a StoreUserDetailsPayload!

Arguments
Name Description
appFeedback - String Free-text feedback submitted by the user from within the app.
appVersion - String The current version string of the client app (e.g. "1.4.2").

Example

Query
mutation storeUserDetails(
  $appFeedback: String,
  $appVersion: String
) {
  storeUserDetails(
    appFeedback: $appFeedback,
    appVersion: $appVersion
  ) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{
  "appFeedback": "abc123",
  "appVersion": "xyz789"
}
Response
{
  "data": {
    "storeUserDetails": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

submitEnneagramAssessment

Description

Submits a completed 40-question Enneagram assessment and persists the result.

Arguments
Name Description
answers - [AnswerInput!]! Array of exactly 40 forced-choice answers.

Example

Query
mutation submitEnneagramAssessment($answers: [AnswerInput!]!) {
  submitEnneagramAssessment(answers: $answers) {
    assessment {
      ...EnneagramAssessmentFragment
    }
    errors
  }
}
Variables
{"answers": [AnswerInput]}
Response
{
  "data": {
    "submitEnneagramAssessment": {
      "assessment": EnneagramAssessment,
      "errors": ["xyz789"]
    }
  }
}

submitTeamPulse

Description

Submits the current member's quarterly team pulse survey response (score 0-10, optional comment). Objectuve-internal telemetry — no team-admin read path exists for this data.

Response

Returns a SubmitTeamPulsePayload!

Arguments
Name Description
comment - String
score - Int!
teamId - String!

Example

Query
mutation submitTeamPulse(
  $comment: String,
  $score: Int!,
  $teamId: String!
) {
  submitTeamPulse(
    comment: $comment,
    score: $score,
    teamId: $teamId
  ) {
    errors
    record {
      ...TeamPulseConfirmationFragment
    }
  }
}
Variables
{
  "comment": "abc123",
  "score": 987,
  "teamId": "abc123"
}
Response
{
  "data": {
    "submitTeamPulse": {
      "errors": ["abc123"],
      "record": TeamPulseConfirmation
    }
  }
}

suggestGoals

Description

Uses AI to turn goal-discovery quiz answers into 3-5 suggested goals, each with a rationale.

Response

Returns a SuggestGoalsPayload!

Arguments
Name Description
lifeAreas - [String!]! Up to 3 life-area labels the user picked (Q1).
pull - String! What would move the needle most right now (Q2).
rhythm - String! How much time the user can realistically give (Q3).
why - String What's driving this — optional/skippable (Q4).

Example

Query
mutation suggestGoals(
  $lifeAreas: [String!]!,
  $pull: String!,
  $rhythm: String!,
  $why: String
) {
  suggestGoals(
    lifeAreas: $lifeAreas,
    pull: $pull,
    rhythm: $rhythm,
    why: $why
  ) {
    aiRequest {
      ...AiRequestFragment
    }
    errors
    suggestions {
      ...SuggestedGoalFragment
    }
  }
}
Variables
{
  "lifeAreas": ["abc123"],
  "pull": "abc123",
  "rhythm": "abc123",
  "why": "abc123"
}
Response
{
  "data": {
    "suggestGoals": {
      "aiRequest": AiRequest,
      "errors": ["xyz789"],
      "suggestions": [SuggestedGoal]
    }
  }
}

syncUser

Description

Syncs the authenticated Clerk user with the local database. Returns first_sign_in for onboarding detection.

Response

Returns a SyncUserPayload!

Arguments
Name Description
referralCode - String v4.56 Phase 5 (REF-02/REF-03) — a share-link code captured from ?ref= on first landing. Only attributed when this call is a genuine first sign-in.
timezone - String IANA timezone string from the client (e.g. "America/Chicago"). Used to evaluate day boundaries for streak calculations.

Example

Query
mutation syncUser(
  $referralCode: String,
  $timezone: String
) {
  syncUser(
    referralCode: $referralCode,
    timezone: $timezone
  ) {
    errors
    firstSignIn
    user {
      ...UserFragment
    }
  }
}
Variables
{
  "referralCode": "abc123",
  "timezone": "abc123"
}
Response
{
  "data": {
    "syncUser": {
      "errors": ["xyz789"],
      "firstSignIn": false,
      "user": User
    }
  }
}

tickPactRule

Description

Ticks one of the current user's Pact rules for today (D18.3 — member-local today only, no date input). Idempotent: a second tick overwrites amount/note/proof.

Response

Returns a TickPactRulePayload!

Arguments
Name Description
amount - Float
note - String
pactRuleId - ID!
photo - Upload Private proof photo. Takes effect immediately.
sharedWithPact - Boolean

Example

Query
mutation tickPactRule(
  $amount: Float,
  $note: String,
  $pactRuleId: ID!,
  $photo: Upload,
  $sharedWithPact: Boolean
) {
  tickPactRule(
    amount: $amount,
    note: $note,
    pactRuleId: $pactRuleId,
    photo: $photo,
    sharedWithPact: $sharedWithPact
  ) {
    errors
    pact {
      ...PactFragment
    }
    pactTick {
      ...PactTickFragment
    }
  }
}
Variables
{
  "amount": 987.65,
  "note": "xyz789",
  "pactRuleId": 4,
  "photo": Upload,
  "sharedWithPact": true
}
Response
{
  "data": {
    "tickPactRule": {
      "errors": ["xyz789"],
      "pact": Pact,
      "pactTick": PactTick
    }
  }
}

toggleFeedbackVote

Description

Toggles a vote on a feedback post. Adds a vote if not voted, removes if already voted.

Response

Returns a ToggleFeedbackVotePayload!

Arguments
Name Description
postId - ID! Public ID of the feedback post to vote on.

Example

Query
mutation toggleFeedbackVote($postId: ID!) {
  toggleFeedbackVote(postId: $postId) {
    errors
    feedbackPost {
      ...FeedbackPostFragment
    }
    voted
  }
}
Variables
{"postId": 4}
Response
{
  "data": {
    "toggleFeedbackVote": {
      "errors": ["abc123"],
      "feedbackPost": FeedbackPost,
      "voted": false
    }
  }
}

toggleFollowGoal

Description

Follows or unfollows a goal. Toggles the follow state for the authenticated user.

Response

Returns a ToggleFollowGoalPayload!

Arguments
Name Description
goalId - ID! public_id of the goal to follow or unfollow.

Example

Query
mutation toggleFollowGoal($goalId: ID!) {
  toggleFollowGoal(goalId: $goalId) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"goalId": "4"}
Response
{
  "data": {
    "toggleFollowGoal": {
      "errors": ["abc123"],
      "result": Result
    }
  }
}

transferTeamBillingOwnership

Description

Owner-only. Transfers billing ownership to another existing team member.

Arguments
Name Description
newOwnerId - String! The new owner's user public_id.
teamId - String!

Example

Query
mutation transferTeamBillingOwnership(
  $newOwnerId: String!,
  $teamId: String!
) {
  transferTeamBillingOwnership(
    newOwnerId: $newOwnerId,
    teamId: $teamId
  ) {
    errors
    team {
      ...TeamFragment
    }
  }
}
Variables
{
  "newOwnerId": "xyz789",
  "teamId": "abc123"
}
Response
{
  "data": {
    "transferTeamBillingOwnership": {
      "errors": ["xyz789"],
      "team": Team
    }
  }
}

triggerAiRun

Response

Returns a TriggerAiRunPayload!

Arguments
Name Description
employeeId - String!

Example

Query
mutation triggerAiRun($employeeId: String!) {
  triggerAiRun(employeeId: $employeeId) {
    errors
    run {
      ...AiRunFragment
    }
  }
}
Variables
{"employeeId": "xyz789"}
Response
{
  "data": {
    "triggerAiRun": {
      "errors": ["xyz789"],
      "run": AiRun
    }
  }
}

unarchiveSubCommunity

Description

Owner/Admin-only. Reverses an in-progress sub-community archive within the 30-day window.

Response

Returns an UnarchiveSubCommunityPayload!

Arguments
Name Description
communityId - String!
teamId - String!

Example

Query
mutation unarchiveSubCommunity(
  $communityId: String!,
  $teamId: String!
) {
  unarchiveSubCommunity(
    communityId: $communityId,
    teamId: $teamId
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "communityId": "xyz789",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "unarchiveSubCommunity": {
      "community": Community,
      "errors": ["abc123"]
    }
  }
}

unblockUser

Description

Unblocks a user, restoring visibility of their content in both directions.

Response

Returns an UnblockAllyPayload!

Arguments
Name Description
targetUserId - ID! public_id of the user to unblock.

Example

Query
mutation unblockUser($targetUserId: ID!) {
  unblockUser(targetUserId: $targetUserId) {
    errors
    success
  }
}
Variables
{"targetUserId": 4}
Response
{
  "data": {
    "unblockUser": {
      "errors": ["xyz789"],
      "success": true
    }
  }
}

undoAiArtifactApproval

Description

Undoes an approval inside its grace window. The artifact goes back to pending exactly as it was before approval, and nothing is delivered. Returns one result per ID; one failure never blocks the rest.

Response

Returns an UndoAiArtifactApprovalPayload!

Arguments
Name Description
artifactIds - [String!]!

Example

Query
mutation undoAiArtifactApproval($artifactIds: [String!]!) {
  undoAiArtifactApproval(artifactIds: $artifactIds) {
    errors
    results {
      ...AiArtifactBulkResultFragment
    }
  }
}
Variables
{"artifactIds": ["xyz789"]}
Response
{
  "data": {
    "undoAiArtifactApproval": {
      "errors": ["abc123"],
      "results": [AiArtifactBulkResult]
    }
  }
}

undoCoachProposal

Description

Undo an applied Coach proposal inside its 10-minute window, if the goals were not edited since.

Response

Returns an UndoCoachProposalPayload!

Arguments
Name Description
id - ID! public_id of the Coach proposal.

Example

Query
mutation undoCoachProposal($id: ID!) {
  undoCoachProposal(id: $id) {
    coachProposal {
      ...CoachProposalFragment
    }
    errors
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "undoCoachProposal": {
      "coachProposal": CoachProposal,
      "errors": ["xyz789"]
    }
  }
}

undoHeadCoachAction

Description

Undo a reversible Head Coach write within its 10-minute window. Only the admin who ran it, and only while their role and crew access still allow it. Super-admin only, behind the head_coach_enabled kill switch.

Response

Returns an UndoHeadCoachActionPayload!

Arguments
Name Description
actionId - ID! public_id of the Head Coach action to undo.

Example

Query
mutation undoHeadCoachAction($actionId: ID!) {
  undoHeadCoachAction(actionId: $actionId) {
    action {
      ...HeadCoachActionFragment
    }
    errors
    success
  }
}
Variables
{"actionId": 4}
Response
{
  "data": {
    "undoHeadCoachAction": {
      "action": HeadCoachAction,
      "errors": ["xyz789"],
      "success": true
    }
  }
}

unfollowCommunity

Description

Unfollows a community the authenticated user is currently following.

Response

Returns an UnfollowCommunityPayload!

Arguments
Name Description
communityId - ID! The public ID of the community to unfollow.
userId - ID! The public ID of the user unfollowing the community.

Example

Query
mutation unfollowCommunity(
  $communityId: ID!,
  $userId: ID!
) {
  unfollowCommunity(
    communityId: $communityId,
    userId: $userId
  ) {
    errors
    result {
      ...ResultFragment
    }
  }
}
Variables
{"communityId": 4, "userId": 4}
Response
{
  "data": {
    "unfollowCommunity": {
      "errors": ["xyz789"],
      "result": Result
    }
  }
}

unlinkPactRuleSync

Description

Opts the current user's own Pact rule out of Strava sync (S11). Owner-only and flag-gated. Ticks already written are untouched.

Response

Returns an UnlinkPactRuleSyncPayload!

Arguments
Name Description
pactRuleId - ID!

Example

Query
mutation unlinkPactRuleSync($pactRuleId: ID!) {
  unlinkPactRuleSync(pactRuleId: $pactRuleId) {
    errors
    pactRule {
      ...PactRuleFragment
    }
  }
}
Variables
{"pactRuleId": 4}
Response
{
  "data": {
    "unlinkPactRuleSync": {
      "errors": ["abc123"],
      "pactRule": PactRule
    }
  }
}

unlinkPractice

Description

Clears a habit's practice link. The goal it supported is left untouched. Owner-only.

Response

Returns an UnlinkPracticePayload!

Arguments
Name Description
practiceId - ID! public_id of the practice to unlink.

Example

Query
mutation unlinkPractice($practiceId: ID!) {
  unlinkPractice(practiceId: $practiceId) {
    errors
    practice {
      ...GoalFragment
    }
  }
}
Variables
{"practiceId": 4}
Response
{
  "data": {
    "unlinkPractice": {
      "errors": ["xyz789"],
      "practice": Goal
    }
  }
}

unpinAdminDashboardCard

Description

Unpin one of the caller's own pinned Dashboard cards. Admin roles that manage dashboard pins only. Audit-logged.

Response

Returns an UnpinAdminDashboardCardPayload!

Arguments
Name Description
cardKey - String! daily_active_users | goal_themes | recent_activity.

Example

Query
mutation unpinAdminDashboardCard($cardKey: String!) {
  unpinAdminDashboardCard(cardKey: $cardKey) {
    errors
    success
  }
}
Variables
{"cardKey": "xyz789"}
Response
{
  "data": {
    "unpinAdminDashboardCard": {
      "errors": ["abc123"],
      "success": false
    }
  }
}

untickPactRule

Description

Undoes today's tick of one of the current user's Pact rules (D18.1/D18.2). Never reverts the linked habit check-in. Fails once the day/week is decided.

Response

Returns an UntickPactRulePayload!

Arguments
Name Description
pactRuleId - ID!

Example

Query
mutation untickPactRule($pactRuleId: ID!) {
  untickPactRule(pactRuleId: $pactRuleId) {
    errors
    pact {
      ...PactFragment
    }
  }
}
Variables
{"pactRuleId": "4"}
Response
{
  "data": {
    "untickPactRule": {
      "errors": ["xyz789"],
      "pact": Pact
    }
  }
}

updateAiAssignment

Response

Returns an UpdateAiAssignmentPayload!

Arguments
Name Description
description - String
id - String!
title - String

Example

Query
mutation updateAiAssignment(
  $description: String,
  $id: String!,
  $title: String
) {
  updateAiAssignment(
    description: $description,
    id: $id,
    title: $title
  ) {
    assignment {
      ...AiAssignmentFragment
    }
    errors
  }
}
Variables
{
  "description": "abc123",
  "id": "abc123",
  "title": "xyz789"
}
Response
{
  "data": {
    "updateAiAssignment": {
      "assignment": AiAssignment,
      "errors": ["xyz789"]
    }
  }
}

updateAiAutopilot

Response

Returns an UpdateAiAutopilotPayload!

Arguments
Name Description
autopilotId - String!
cooldownSeconds - Int
eventKind - String
filter - JSON
instructions - String
name - String
postsPerRun - Int Added to the instructions each run. 0 clears it.
scheduleCron - String Five-field cron, read in timeZone.
timeZone - String IANA time zone, e.g. America/Chicago.
triggerType - String schedule or event. Clears the other mode's fields.

Example

Query
mutation updateAiAutopilot(
  $autopilotId: String!,
  $cooldownSeconds: Int,
  $eventKind: String,
  $filter: JSON,
  $instructions: String,
  $name: String,
  $postsPerRun: Int,
  $scheduleCron: String,
  $timeZone: String,
  $triggerType: String
) {
  updateAiAutopilot(
    autopilotId: $autopilotId,
    cooldownSeconds: $cooldownSeconds,
    eventKind: $eventKind,
    filter: $filter,
    instructions: $instructions,
    name: $name,
    postsPerRun: $postsPerRun,
    scheduleCron: $scheduleCron,
    timeZone: $timeZone,
    triggerType: $triggerType
  ) {
    autopilot {
      ...AiAutopilotFragment
    }
    errors
  }
}
Variables
{
  "autopilotId": "abc123",
  "cooldownSeconds": 123,
  "eventKind": "xyz789",
  "filter": {},
  "instructions": "abc123",
  "name": "xyz789",
  "postsPerRun": 987,
  "scheduleCron": "xyz789",
  "timeZone": "xyz789",
  "triggerType": "xyz789"
}
Response
{
  "data": {
    "updateAiAutopilot": {
      "autopilot": AiAutopilot,
      "errors": ["xyz789"]
    }
  }
}

updateAiEmployee

Response

Returns an UpdateAiEmployeePayload!

Arguments
Name Description
autonomyLevel - String
confirmPromotion - Boolean
crew - String
description - String
employeeId - String!
mcpServers - [String!]
modelPreference - String
monthlyBudgetCents - Int
name - String
postFilterSkill - String
scheduleCron - String
skillRefs - [String!]
taskPrompt - String

Example

Query
mutation updateAiEmployee(
  $autonomyLevel: String,
  $confirmPromotion: Boolean,
  $crew: String,
  $description: String,
  $employeeId: String!,
  $mcpServers: [String!],
  $modelPreference: String,
  $monthlyBudgetCents: Int,
  $name: String,
  $postFilterSkill: String,
  $scheduleCron: String,
  $skillRefs: [String!],
  $taskPrompt: String
) {
  updateAiEmployee(
    autonomyLevel: $autonomyLevel,
    confirmPromotion: $confirmPromotion,
    crew: $crew,
    description: $description,
    employeeId: $employeeId,
    mcpServers: $mcpServers,
    modelPreference: $modelPreference,
    monthlyBudgetCents: $monthlyBudgetCents,
    name: $name,
    postFilterSkill: $postFilterSkill,
    scheduleCron: $scheduleCron,
    skillRefs: $skillRefs,
    taskPrompt: $taskPrompt
  ) {
    employee {
      ...AiEmployeeFragment
    }
    errors
  }
}
Variables
{
  "autonomyLevel": "xyz789",
  "confirmPromotion": false,
  "crew": "xyz789",
  "description": "abc123",
  "employeeId": "xyz789",
  "mcpServers": ["abc123"],
  "modelPreference": "xyz789",
  "monthlyBudgetCents": 123,
  "name": "abc123",
  "postFilterSkill": "abc123",
  "scheduleCron": "xyz789",
  "skillRefs": ["abc123"],
  "taskPrompt": "xyz789"
}
Response
{
  "data": {
    "updateAiEmployee": {
      "employee": AiEmployee,
      "errors": ["abc123"]
    }
  }
}

updateCelebrationPreferences

Description

Updates how the current user's encouragement celebration plays. Only the arguments passed in change.

Arguments
Name Description
autoClose - Boolean Whether the celebration closes itself after its countdown.
confetti - CelebrationConfettiEnum How much confetti the celebration shows.
reducedMotion - CelebrationReducedMotionEnum Whether the celebration reduces its motion.

Example

Query
mutation updateCelebrationPreferences(
  $autoClose: Boolean,
  $confetti: CelebrationConfettiEnum,
  $reducedMotion: CelebrationReducedMotionEnum
) {
  updateCelebrationPreferences(
    autoClose: $autoClose,
    confetti: $confetti,
    reducedMotion: $reducedMotion
  ) {
    celebrationPreferences {
      ...CelebrationPreferencesFragment
    }
    errors
  }
}
Variables
{"autoClose": true, "confetti": "LOTS", "reducedMotion": "OFF"}
Response
{
  "data": {
    "updateCelebrationPreferences": {
      "celebrationPreferences": CelebrationPreferences,
      "errors": ["abc123"]
    }
  }
}

updateChallenge

Description

Updates an existing cause challenge (v4.126 D2): title, cause, organizer, URLs, dates, and total.

Response

Returns an UpdateChallengePayload!

Arguments
Name Description
causeLabel - String Updated cause label, max 40 chars.
donationUrl - String Updated donation link. https:// only.
endsOn - ISO8601Date Updated last day of the window. Keeps the goal's targetDate in sync.
goalId - ID! public_id of the challenge goal to update.
organizerName - String Updated organizer name, max 60 chars.
sourceUrl - String Updated source link. https:// only.
startsOn - ISO8601Date Updated first day of the window.
targetAmount - Float Updated challenge total.
title - String Updated challenge/event name, max 100 chars.

Example

Query
mutation updateChallenge(
  $causeLabel: String,
  $donationUrl: String,
  $endsOn: ISO8601Date,
  $goalId: ID!,
  $organizerName: String,
  $sourceUrl: String,
  $startsOn: ISO8601Date,
  $targetAmount: Float,
  $title: String
) {
  updateChallenge(
    causeLabel: $causeLabel,
    donationUrl: $donationUrl,
    endsOn: $endsOn,
    goalId: $goalId,
    organizerName: $organizerName,
    sourceUrl: $sourceUrl,
    startsOn: $startsOn,
    targetAmount: $targetAmount,
    title: $title
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{
  "causeLabel": "xyz789",
  "donationUrl": "abc123",
  "endsOn": ISO8601Date,
  "goalId": 4,
  "organizerName": "abc123",
  "sourceUrl": "abc123",
  "startsOn": ISO8601Date,
  "targetAmount": 987.65,
  "title": "xyz789"
}
Response
{
  "data": {
    "updateChallenge": {
      "errors": ["abc123"],
      "goal": Goal
    }
  }
}

updateCharterPreferences

Description

Updates the authenticated user's charter-cohort preferences (marker_hidden, notes_enabled). Self-only.

Response

Returns an UpdateCharterPreferencesPayload!

Arguments
Name Description
markerHidden - Boolean Hide the charter member marker from other viewers. Omit to leave unchanged.
notesEnabled - Boolean Opt in to the Charter notes email. Omit to leave unchanged.

Example

Query
mutation updateCharterPreferences(
  $markerHidden: Boolean,
  $notesEnabled: Boolean
) {
  updateCharterPreferences(
    markerHidden: $markerHidden,
    notesEnabled: $notesEnabled
  ) {
    errors
    user {
      ...UserFragment
    }
  }
}
Variables
{"markerHidden": true, "notesEnabled": true}
Response
{
  "data": {
    "updateCharterPreferences": {
      "errors": ["xyz789"],
      "user": User
    }
  }
}

updateCoachModel

Description

Switches the runtime Coach Gemini model. Admin only.

Response

Returns an UpdateCoachModelPayload!

Arguments
Name Description
model - String!

Example

Query
mutation updateCoachModel($model: String!) {
  updateCoachModel(model: $model) {
    errors
    setting {
      ...CoachModelSettingFragment
    }
  }
}
Variables
{"model": "abc123"}
Response
{
  "data": {
    "updateCoachModel": {
      "errors": ["xyz789"],
      "setting": CoachModelSetting
    }
  }
}

updateCoachWarmupContext

Description

Stores the user's post-wizard warmup answers for Coach personalization.

Response

Returns an UpdateCoachWarmupContextPayload!

Arguments
Name Description
feedbackStyle - String! The style of feedback the user prefers from Coach.
missedDayResponse - String! How the user wants Coach to respond when they miss a day.
timeOfDay - String! When the user typically works on goals (e.g. "morning", "after work").

Example

Query
mutation updateCoachWarmupContext(
  $feedbackStyle: String!,
  $missedDayResponse: String!,
  $timeOfDay: String!
) {
  updateCoachWarmupContext(
    feedbackStyle: $feedbackStyle,
    missedDayResponse: $missedDayResponse,
    timeOfDay: $timeOfDay
  ) {
    errors
    userDetail {
      ...UserDetailFragment
    }
  }
}
Variables
{
  "feedbackStyle": "abc123",
  "missedDayResponse": "xyz789",
  "timeOfDay": "xyz789"
}
Response
{
  "data": {
    "updateCoachWarmupContext": {
      "errors": ["xyz789"],
      "userDetail": UserDetail
    }
  }
}

updateCoachingPreferences

Description

Updates the current user's AI Coach persona, tone, depth, focus areas, and communication frequency.

Response

Returns an UpdateCoachingPreferencesPayload!

Arguments
Name Description
depth - Int Response depth from 1 (brief) to 5 (detailed).
focusPrimary - String Primary coaching focus area.
focusSecondary - String Optional secondary coaching focus area (null to clear).
persona - String Coaching persona: captain, spark, mirror, rival, sage, or analyst.
rhythm - String Communication rhythm: daily or when_needed.
toneWarmth - Int Tone warmth from 0 to 4.

Example

Query
mutation updateCoachingPreferences(
  $depth: Int,
  $focusPrimary: String,
  $focusSecondary: String,
  $persona: String,
  $rhythm: String,
  $toneWarmth: Int
) {
  updateCoachingPreferences(
    depth: $depth,
    focusPrimary: $focusPrimary,
    focusSecondary: $focusSecondary,
    persona: $persona,
    rhythm: $rhythm,
    toneWarmth: $toneWarmth
  ) {
    coachingPreferences {
      ...CoachingPreferencesFragment
    }
    errors
  }
}
Variables
{
  "depth": 987,
  "focusPrimary": "abc123",
  "focusSecondary": "xyz789",
  "persona": "abc123",
  "rhythm": "xyz789",
  "toneWarmth": 987
}
Response
{
  "data": {
    "updateCoachingPreferences": {
      "coachingPreferences": CoachingPreferences,
      "errors": ["xyz789"]
    }
  }
}

updateCommunityEvent

Description

Edits a meetup. The creator, a community admin/moderator, or a site admin (D2).

Response

Returns an UpdateCommunityEventPayload!

Arguments
Name Description
description - String Optional details, at most 1,000 characters.
endsAt - ISO8601DateTime Optional end time.
eventId - ID! public_id of the meetup to edit.
location - String A place or a link for online meetups.
startsAt - ISO8601DateTime! When the meetup starts.
title - String! Title of the meetup.

Example

Query
mutation updateCommunityEvent(
  $description: String,
  $endsAt: ISO8601DateTime,
  $eventId: ID!,
  $location: String,
  $startsAt: ISO8601DateTime!,
  $title: String!
) {
  updateCommunityEvent(
    description: $description,
    endsAt: $endsAt,
    eventId: $eventId,
    location: $location,
    startsAt: $startsAt,
    title: $title
  ) {
    communityEvent {
      ...CommunityEventFragment
    }
    errorCode
    errors
  }
}
Variables
{
  "description": "xyz789",
  "endsAt": ISO8601DateTime,
  "eventId": 4,
  "location": "xyz789",
  "startsAt": ISO8601DateTime,
  "title": "xyz789"
}
Response
{
  "data": {
    "updateCommunityEvent": {
      "communityEvent": CommunityEvent,
      "errorCode": "abc123",
      "errors": ["xyz789"]
    }
  }
}

updateDashboardPreferences

Description

Updates the current user's dashboard mode and density preferences (v4.15).

Arguments
Name Description
migratedFromFull - Boolean Set when this call performs the one-time legacy full→Detailed backfill.
mode - String Dashboard mode: focus, standard, detailed, or auto.

Example

Query
mutation updateDashboardPreferences(
  $migratedFromFull: Boolean,
  $mode: String
) {
  updateDashboardPreferences(
    migratedFromFull: $migratedFromFull,
    mode: $mode
  ) {
    dashboardPreferences {
      ...DashboardPreferencesFragment
    }
    errors
  }
}
Variables
{
  "migratedFromFull": false,
  "mode": "abc123"
}
Response
{
  "data": {
    "updateDashboardPreferences": {
      "dashboardPreferences": DashboardPreferences,
      "errors": ["abc123"]
    }
  }
}

updateDemoCommunity

Description

Inline-edit a demo community. super_admin only.

Response

Returns an UpdateDemoCommunityPayload!

Arguments
Name Description
attributes - DemoCommunityAttributesInput!
communityId - ID!

Example

Query
mutation updateDemoCommunity(
  $attributes: DemoCommunityAttributesInput!,
  $communityId: ID!
) {
  updateDemoCommunity(
    attributes: $attributes,
    communityId: $communityId
  ) {
    community {
      ...CommunityFragment
    }
    errors
  }
}
Variables
{
  "attributes": DemoCommunityAttributesInput,
  "communityId": "4"
}
Response
{
  "data": {
    "updateDemoCommunity": {
      "community": Community,
      "errors": ["abc123"]
    }
  }
}

updateDemoGoal

Description

Inline-edit a demo goal. super_admin only.

Response

Returns an UpdateDemoGoalPayload!

Arguments
Name Description
attributes - DemoGoalAttributesInput!
goalId - ID!

Example

Query
mutation updateDemoGoal(
  $attributes: DemoGoalAttributesInput!,
  $goalId: ID!
) {
  updateDemoGoal(
    attributes: $attributes,
    goalId: $goalId
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{
  "attributes": DemoGoalAttributesInput,
  "goalId": "4"
}
Response
{
  "data": {
    "updateDemoGoal": {
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

updateDemoUser

Description

Inline-edit a demo user. super_admin only.

Response

Returns an UpdateDemoUserPayload!

Arguments
Name Description
attributes - DemoUserAttributesInput!
userId - ID!

Example

Query
mutation updateDemoUser(
  $attributes: DemoUserAttributesInput!,
  $userId: ID!
) {
  updateDemoUser(
    attributes: $attributes,
    userId: $userId
  ) {
    errors
    user {
      ...UserFragment
    }
  }
}
Variables
{"attributes": DemoUserAttributesInput, "userId": 4}
Response
{
  "data": {
    "updateDemoUser": {
      "errors": ["xyz789"],
      "user": User
    }
  }
}

updateFeedbackPostStatus

Description

Updates the status of a feedback post (admin only).

Response

Returns an UpdateFeedbackPostStatusPayload!

Arguments
Name Description
postId - ID! Public ID of the feedback post.
status - String! New status: open, planned, in_progress, completed, or declined.

Example

Query
mutation updateFeedbackPostStatus(
  $postId: ID!,
  $status: String!
) {
  updateFeedbackPostStatus(
    postId: $postId,
    status: $status
  ) {
    errors
    feedbackPost {
      ...FeedbackPostFragment
    }
  }
}
Variables
{
  "postId": "4",
  "status": "abc123"
}
Response
{
  "data": {
    "updateFeedbackPostStatus": {
      "errors": ["abc123"],
      "feedbackPost": FeedbackPost
    }
  }
}

updateFeedbackPostTags

Description

Updates the tags on a feedback post (admin only).

Response

Returns an UpdateFeedbackPostTagsPayload!

Arguments
Name Description
postId - ID! Public ID of the feedback post.
tagIds - [ID!]! Public IDs of the tags to set on the post (up to 3).

Example

Query
mutation updateFeedbackPostTags(
  $postId: ID!,
  $tagIds: [ID!]!
) {
  updateFeedbackPostTags(
    postId: $postId,
    tagIds: $tagIds
  ) {
    errors
    feedbackPost {
      ...FeedbackPostFragment
    }
  }
}
Variables
{"postId": 4, "tagIds": [4]}
Response
{
  "data": {
    "updateFeedbackPostTags": {
      "errors": ["abc123"],
      "feedbackPost": FeedbackPost
    }
  }
}

updateFeedbackTag

Description

Updates an existing feedback tag (admin only).

Response

Returns an UpdateFeedbackTagPayload!

Arguments
Name Description
description - String New description.
name - String New display name.
tagId - ID! Public ID of the feedback tag.

Example

Query
mutation updateFeedbackTag(
  $description: String,
  $name: String,
  $tagId: ID!
) {
  updateFeedbackTag(
    description: $description,
    name: $name,
    tagId: $tagId
  ) {
    errors
    feedbackTag {
      ...FeedbackTagFragment
    }
  }
}
Variables
{
  "description": "xyz789",
  "name": "xyz789",
  "tagId": 4
}
Response
{
  "data": {
    "updateFeedbackTag": {
      "errors": ["abc123"],
      "feedbackTag": FeedbackTag
    }
  }
}

updateGoal

Description

Updates an existing goal owned by the authenticated user.

Response

Returns an UpdateGoalPayload!

Arguments
Name Description
appLink - String Updated external app URL (https:// or a custom app scheme, e.g. duolingo://) opened on check-in for one-click redirect to another app.
completed - Boolean When true, marks the goal as completed.
completionReflection - String Optional free-text reflection captured when the goal is marked complete. Personalizes Coach messaging when present. Max 200 chars.
content - String Updated description or motivation note.
currentAmount - Float Updated "So far" progress toward targetAmount. Send null to clear (v4.109).
daysToUpdate - Int Updated frequency in days that the user plans to log progress.
deleted - Boolean When true, soft-deletes the goal.
durationMinutes - Int Optional time-per-session in minutes for habits.
file - Upload Cover image file upload. Takes precedence over image_url when provided.
goalCategoryId - ID Updated goal category ID. Fetch options via goalCategories query.
goalId - ID! public_id of the goal to update.
goalShape - String Updated Finish line / Habit / Someday picker value (sprint, arc, habit, life-list). When present, wins over goalTypeId, clears or sets target date / recurrence / daysToUpdate per the shape, and can actually clear targetDate (see GoalTracking::GoalShapeAttributes).
goalTypeId - ID Updated goal type ID. Fetch options via goalKinds query.
habitCadence - PracticeCadenceEnum Cadence for the habit-shape path. Ignored unless goalShape is habit, and loses to an explicit recurrenceType/recurrenceDays/recurrenceInterval.
habitWeeklyTarget - Int Times per week for habitCadence TIMES_PER_WEEK: 1-6. Defaults to the goal's current weekly target, else 3. Ignored for every other cadence and unless goalShape is habit.
identityPrompt - String Optional free-text identity framing (e.g. "Who you're becoming"). Personalizes Coach messaging when present. Max 240 chars.
identityPromptQuotable - Boolean Send true alongside identityPrompt when the client shows disclosure copy that reminders may quote this text verbatim. Defaults to false (not quotable).
imageUrl - String Updated URL of a cover image for the goal.
lockVersion - Int Optimistic-lock version read when the goal was loaded. When provided, the update fails with a conflict if the goal changed since then. Omit to update without a conflict check (all non-edit-form callers).
name - String Updated display name for the goal.
pastAttemptContext - String Optional free-text context on a prior attempt at this goal. Personalizes Coach messaging when present. Max 200 chars.
private - Boolean Deprecated; use visibility. When true, the goal is visible only to the owner.
recurrenceDays - [String!] Updated days for weekly/custom_days recurrence.
recurrenceInterval - Int Updated number of days between check-ins for interval recurrence.
recurrenceType - String Updated recurrence pattern for habits: daily, weekly, custom_days, times_per_week, or interval.
steps - [StepInput!] Structured roadmap step diff. Upserts by public_id; omitted existing steps soft-delete.
supportsGoalId - ID public_id of a long goal this top-level habit practices toward. Only valid on a top-level habit, targeting the same user's top-level, non-habit goal. Use unlinkPractice to clear it.
targetAmount - Float Updated measure target (e.g. 100 for "run 100 miles"). Must be paired with unit — sending either as null clears both (v4.109).
targetDate - String Updated ISO date string for the target completion date (e.g. "2026-12-31").
unit - String Updated measure unit (e.g. "miles"), max 20 chars. Paired with targetAmount. Sending either as null clears both (v4.109).
visibility - GoalVisibilityEnum Who can see the goal. Wins over private when both are sent.
weeklyTarget - Int Check-ins per week (1-6) for an explicit recurrenceType times_per_week. Cleared whenever the recurrence type is anything else.

Example

Query
mutation updateGoal(
  $appLink: String,
  $completed: Boolean,
  $completionReflection: String,
  $content: String,
  $currentAmount: Float,
  $daysToUpdate: Int,
  $deleted: Boolean,
  $durationMinutes: Int,
  $file: Upload,
  $goalCategoryId: ID,
  $goalId: ID!,
  $goalShape: String,
  $goalTypeId: ID,
  $habitCadence: PracticeCadenceEnum,
  $habitWeeklyTarget: Int,
  $identityPrompt: String,
  $identityPromptQuotable: Boolean,
  $imageUrl: String,
  $lockVersion: Int,
  $name: String,
  $pastAttemptContext: String,
  $private: Boolean,
  $recurrenceDays: [String!],
  $recurrenceInterval: Int,
  $recurrenceType: String,
  $steps: [StepInput!],
  $supportsGoalId: ID,
  $targetAmount: Float,
  $targetDate: String,
  $unit: String,
  $visibility: GoalVisibilityEnum,
  $weeklyTarget: Int
) {
  updateGoal(
    appLink: $appLink,
    completed: $completed,
    completionReflection: $completionReflection,
    content: $content,
    currentAmount: $currentAmount,
    daysToUpdate: $daysToUpdate,
    deleted: $deleted,
    durationMinutes: $durationMinutes,
    file: $file,
    goalCategoryId: $goalCategoryId,
    goalId: $goalId,
    goalShape: $goalShape,
    goalTypeId: $goalTypeId,
    habitCadence: $habitCadence,
    habitWeeklyTarget: $habitWeeklyTarget,
    identityPrompt: $identityPrompt,
    identityPromptQuotable: $identityPromptQuotable,
    imageUrl: $imageUrl,
    lockVersion: $lockVersion,
    name: $name,
    pastAttemptContext: $pastAttemptContext,
    private: $private,
    recurrenceDays: $recurrenceDays,
    recurrenceInterval: $recurrenceInterval,
    recurrenceType: $recurrenceType,
    steps: $steps,
    supportsGoalId: $supportsGoalId,
    targetAmount: $targetAmount,
    targetDate: $targetDate,
    unit: $unit,
    visibility: $visibility,
    weeklyTarget: $weeklyTarget
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{
  "appLink": "abc123",
  "completed": true,
  "completionReflection": "xyz789",
  "content": "xyz789",
  "currentAmount": 987.65,
  "daysToUpdate": 987,
  "deleted": false,
  "durationMinutes": 987,
  "file": Upload,
  "goalCategoryId": 4,
  "goalId": 4,
  "goalShape": "xyz789",
  "goalTypeId": "4",
  "habitCadence": "DAILY",
  "habitWeeklyTarget": 123,
  "identityPrompt": "abc123",
  "identityPromptQuotable": true,
  "imageUrl": "xyz789",
  "lockVersion": 123,
  "name": "abc123",
  "pastAttemptContext": "abc123",
  "private": true,
  "recurrenceDays": ["xyz789"],
  "recurrenceInterval": 987,
  "recurrenceType": "xyz789",
  "steps": [StepInput],
  "supportsGoalId": "4",
  "targetAmount": 987.65,
  "targetDate": "abc123",
  "unit": "xyz789",
  "visibility": "ALLIES",
  "weeklyTarget": 123
}
Response
{
  "data": {
    "updateGoal": {
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

updateGoalEvent

Description

Updates the content or media of an existing goal progress event.

Response

Returns an UpdateGoalEventPayload!

Arguments
Name Description
content - String Updated progress update text.
deleted - Boolean When true, soft-deletes the goal event.
file - Upload Image file upload. Takes precedence over image_url when provided.
goalEventId - ID! public_id of the goal event to update.
goalId - ID public_id of the goal this event belongs to.
imageUrl - String Updated URL of an image attached to the progress event.

Example

Query
mutation updateGoalEvent(
  $content: String,
  $deleted: Boolean,
  $file: Upload,
  $goalEventId: ID!,
  $goalId: ID,
  $imageUrl: String
) {
  updateGoalEvent(
    content: $content,
    deleted: $deleted,
    file: $file,
    goalEventId: $goalEventId,
    goalId: $goalId,
    imageUrl: $imageUrl
  ) {
    errors
    goalEvent {
      ...GoalEventFragment
    }
  }
}
Variables
{
  "content": "abc123",
  "deleted": true,
  "file": Upload,
  "goalEventId": "4",
  "goalId": 4,
  "imageUrl": "xyz789"
}
Response
{
  "data": {
    "updateGoalEvent": {
      "errors": ["abc123"],
      "goalEvent": GoalEvent
    }
  }
}

updateGoalMotivationSnapshot

Description

Saves any subset of the four Goal Motivation Snapshot answers for the current user. Merge semantics — partial saves do not wipe existing keys.

Arguments
Name Description
challenge - String Biggest challenge: starting, staying_consistent, momentum_after_setbacks, knowing_progress.
experience - String Prior goal-tracking experience: never, a_few_times, many_still_going, many_struggled.
socialContext - String Preferred social context: solo, friend_or_partner, team_or_group.
workTime - String Preferred work time: morning, afternoon, evening, varies.

Example

Query
mutation updateGoalMotivationSnapshot(
  $challenge: String,
  $experience: String,
  $socialContext: String,
  $workTime: String
) {
  updateGoalMotivationSnapshot(
    challenge: $challenge,
    experience: $experience,
    socialContext: $socialContext,
    workTime: $workTime
  ) {
    errors
    goalMotivationProfile {
      ...GoalMotivationProfileFragment
    }
  }
}
Variables
{
  "challenge": "abc123",
  "experience": "xyz789",
  "socialContext": "xyz789",
  "workTime": "xyz789"
}
Response
{
  "data": {
    "updateGoalMotivationSnapshot": {
      "errors": ["abc123"],
      "goalMotivationProfile": GoalMotivationProfile
    }
  }
}

updatePact

Description

Updates a Pact. Before start, everything is editable; after start, only name and stakes (D9).

Response

Returns an UpdatePactPayload!

Arguments
Name Description
daysPerWeek - Int
graceDays - Int
lengthDays - Int
missPolicy - String
name - String
pactId - ID!
rules - [PactRuleInput!]
shape - String
stakes - String
startsOn - ISO8601Date
totalTarget - Float
totalUnit - String
visibility - String

Example

Query
mutation updatePact(
  $daysPerWeek: Int,
  $graceDays: Int,
  $lengthDays: Int,
  $missPolicy: String,
  $name: String,
  $pactId: ID!,
  $rules: [PactRuleInput!],
  $shape: String,
  $stakes: String,
  $startsOn: ISO8601Date,
  $totalTarget: Float,
  $totalUnit: String,
  $visibility: String
) {
  updatePact(
    daysPerWeek: $daysPerWeek,
    graceDays: $graceDays,
    lengthDays: $lengthDays,
    missPolicy: $missPolicy,
    name: $name,
    pactId: $pactId,
    rules: $rules,
    shape: $shape,
    stakes: $stakes,
    startsOn: $startsOn,
    totalTarget: $totalTarget,
    totalUnit: $totalUnit,
    visibility: $visibility
  ) {
    errors
    pact {
      ...PactFragment
    }
  }
}
Variables
{
  "daysPerWeek": 123,
  "graceDays": 123,
  "lengthDays": 123,
  "missPolicy": "xyz789",
  "name": "abc123",
  "pactId": 4,
  "rules": [PactRuleInput],
  "shape": "abc123",
  "stakes": "xyz789",
  "startsOn": ISO8601Date,
  "totalTarget": 987.65,
  "totalUnit": "xyz789",
  "visibility": "xyz789"
}
Response
{
  "data": {
    "updatePact": {
      "errors": ["xyz789"],
      "pact": Pact
    }
  }
}

updatePrivacySettings

Description

Updates the authenticated user's privacy toggles (go_it_alone, private_mode). Self-only.

Response

Returns an UpdatePrivacySettingsPayload!

Arguments
Name Description
goItAlone - Boolean Opt out of ally/community/coach-social prompts.
privateMode - Boolean Hide the user from username search.

Example

Query
mutation updatePrivacySettings(
  $goItAlone: Boolean,
  $privateMode: Boolean
) {
  updatePrivacySettings(
    goItAlone: $goItAlone,
    privateMode: $privateMode
  ) {
    errors
    user {
      ...UserFragment
    }
  }
}
Variables
{"goItAlone": false, "privateMode": false}
Response
{
  "data": {
    "updatePrivacySettings": {
      "errors": ["xyz789"],
      "user": User
    }
  }
}

updateSeasonalEvent

Description

Admin only. Updates a platform-wide seasonal event.

Response

Returns an UpdateSeasonalEventPayload!

Arguments
Name Description
badgeIcon - String!
badgeName - String!
description - String
endDate - ISO8601Date!
eventId - ID!
name - String!
slug - String!
startDate - ISO8601Date!
targetGoalCount - Int

Example

Query
mutation updateSeasonalEvent(
  $badgeIcon: String!,
  $badgeName: String!,
  $description: String,
  $endDate: ISO8601Date!,
  $eventId: ID!,
  $name: String!,
  $slug: String!,
  $startDate: ISO8601Date!,
  $targetGoalCount: Int
) {
  updateSeasonalEvent(
    badgeIcon: $badgeIcon,
    badgeName: $badgeName,
    description: $description,
    endDate: $endDate,
    eventId: $eventId,
    name: $name,
    slug: $slug,
    startDate: $startDate,
    targetGoalCount: $targetGoalCount
  ) {
    errors
    seasonalEvent {
      ...SeasonalEventFragment
    }
  }
}
Variables
{
  "badgeIcon": "xyz789",
  "badgeName": "xyz789",
  "description": "abc123",
  "endDate": ISO8601Date,
  "eventId": "4",
  "name": "xyz789",
  "slug": "abc123",
  "startDate": ISO8601Date,
  "targetGoalCount": 987
}
Response
{
  "data": {
    "updateSeasonalEvent": {
      "errors": ["xyz789"],
      "seasonalEvent": SeasonalEvent
    }
  }
}

updateShowcasedAchievements

Description

Updates the list of achievement identifiers the user displays on their public profile.

Arguments
Name Description
achievementKeys - [String!]! Ordered list of achievement identifier keys to display on the public profile.
userId - ID! The public ID of the user whose showcased achievements are being updated.

Example

Query
mutation updateShowcasedAchievements(
  $achievementKeys: [String!]!,
  $userId: ID!
) {
  updateShowcasedAchievements(
    achievementKeys: $achievementKeys,
    userId: $userId
  ) {
    errors
    success
  }
}
Variables
{
  "achievementKeys": ["xyz789"],
  "userId": "4"
}
Response
{
  "data": {
    "updateShowcasedAchievements": {
      "errors": ["abc123"],
      "success": true
    }
  }
}

updateSubCommunity

Description

Owner/Admin-only. Edits an existing sub-community (room) — name, description, icon, join policy, and lead.

Response

Returns an UpdateSubCommunityPayload!

Arguments
Name Description
communityId - String!
description - String
icon - String
joinPolicy - String
leadMembershipId - String
name - String
teamId - String!

Example

Query
mutation updateSubCommunity(
  $communityId: String!,
  $description: String,
  $icon: String,
  $joinPolicy: String,
  $leadMembershipId: String,
  $name: String,
  $teamId: String!
) {
  updateSubCommunity(
    communityId: $communityId,
    description: $description,
    icon: $icon,
    joinPolicy: $joinPolicy,
    leadMembershipId: $leadMembershipId,
    name: $name,
    teamId: $teamId
  ) {
    community {
      ...CommunityFragment
    }
    errors
    teamReadOnly
  }
}
Variables
{
  "communityId": "abc123",
  "description": "abc123",
  "icon": "abc123",
  "joinPolicy": "abc123",
  "leadMembershipId": "abc123",
  "name": "abc123",
  "teamId": "xyz789"
}
Response
{
  "data": {
    "updateSubCommunity": {
      "community": Community,
      "errors": ["xyz789"],
      "teamReadOnly": false
    }
  }
}

updateUser

Description

Updates profile information for the authenticated user.

Response

Returns an UpdateUserPayload!

Arguments
Name Description
deleteUser - Boolean When true, soft-deletes the user account.
email - String A new email address for the user account.
firstName - String The user first name.
lastName - String The user last name.
username - String A new unique username for the user.

Example

Query
mutation updateUser(
  $deleteUser: Boolean,
  $email: String,
  $firstName: String,
  $lastName: String,
  $username: String
) {
  updateUser(
    deleteUser: $deleteUser,
    email: $email,
    firstName: $firstName,
    lastName: $lastName,
    username: $username
  ) {
    errorCode
    errors
    user {
      ...UserFragment
    }
  }
}
Variables
{
  "deleteUser": false,
  "email": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "username": "xyz789"
}
Response
{
  "data": {
    "updateUser": {
      "errorCode": "xyz789",
      "errors": ["abc123"],
      "user": User
    }
  }
}

updateUserPhoto

Description

Updates the profile photo for the authenticated user.

Response

Returns an UpdateUserPhotoPayload!

Arguments
Name Description
file - Upload Image file upload. Takes precedence over image_url when provided.
imageUrl - String Publicly accessible URL of the new profile photo image.

Example

Query
mutation updateUserPhoto(
  $file: Upload,
  $imageUrl: String
) {
  updateUserPhoto(
    file: $file,
    imageUrl: $imageUrl
  ) {
    errors
    userPhoto {
      ...UserPhotoFragment
    }
  }
}
Variables
{
  "file": Upload,
  "imageUrl": "xyz789"
}
Response
{
  "data": {
    "updateUserPhoto": {
      "errors": ["abc123"],
      "userPhoto": UserPhoto
    }
  }
}

updateUserRoles

Description

Updates an admin user's RBAC roles securely logging the execution.

Response

Returns an UpdateUserRolesPayload!

Arguments
Name Description
roles - [String!]!
userId - ID!

Example

Query
mutation updateUserRoles(
  $roles: [String!]!,
  $userId: ID!
) {
  updateUserRoles(
    roles: $roles,
    userId: $userId
  ) {
    errors
    user {
      ...UserFragment
    }
  }
}
Variables
{"roles": ["xyz789"], "userId": 4}
Response
{
  "data": {
    "updateUserRoles": {
      "errors": ["abc123"],
      "user": User
    }
  }
}

useStreakFreeze

Description

Uses a streak freeze token to proactively cover a habit day before it lapses.

Response

Returns a UseStreakFreezePayload!

Arguments
Name Description
goalId - ID! public_id of the habit goal.
missedDate - String! ISO date string to freeze — today through 14 days out; earlier dates are rejected.

Example

Query
mutation useStreakFreeze(
  $goalId: ID!,
  $missedDate: String!
) {
  useStreakFreeze(
    goalId: $goalId,
    missedDate: $missedDate
  ) {
    errors
    goal {
      ...GoalFragment
    }
  }
}
Variables
{"goalId": 4, "missedDate": "abc123"}
Response
{
  "data": {
    "useStreakFreeze": {
      "errors": ["xyz789"],
      "goal": Goal
    }
  }
}

verifyMagicCode

Description

Verifies a magic sign-in code and returns a session token.

Response

Returns a VerifyMagicCodePayload!

Arguments
Name Description
challenge - String!
code - String!
email - String!

Example

Query
mutation verifyMagicCode(
  $challenge: String!,
  $code: String!,
  $email: String!
) {
  verifyMagicCode(
    challenge: $challenge,
    code: $code,
    email: $email
  ) {
    errors
    token
    user {
      ...UserFragment
    }
  }
}
Variables
{
  "challenge": "abc123",
  "code": "xyz789",
  "email": "xyz789"
}
Response
{
  "data": {
    "verifyMagicCode": {
      "errors": ["xyz789"],
      "token": "abc123",
      "user": User
    }
  }
}

withdrawEncouragement

Description

Withdraws an encouragement the current user gave. Does not retract any notification already sent.

Response

Returns a WithdrawEncouragementPayload!

Arguments
Name Description
encouragementId - ID! public_id of the encouragement to withdraw.

Example

Query
mutation withdrawEncouragement($encouragementId: ID!) {
  withdrawEncouragement(encouragementId: $encouragementId) {
    encouragement {
      ...EncouragementFragment
    }
    errorCode
    errors
  }
}
Variables
{"encouragementId": "4"}
Response
{
  "data": {
    "withdrawEncouragement": {
      "encouragement": Encouragement,
      "errorCode": "abc123",
      "errors": ["xyz789"]
    }
  }
}

Subscriptions

achievementUnlocked

Description

Streams newly awarded badges for a user in real time.

Response

Returns a UserAction

Arguments
Name Description
userId - ID! public_id of the user to subscribe to achievement unlocks for.

Example

Query
subscription achievementUnlocked($userId: ID!) {
  achievementUnlocked(userId: $userId) {
    acknowledged
    action
    communityName
    createdAtTime
    id
    source {
      ...BadgeSourceFragment
    }
  }
}
Variables
{"userId": "4"}
Response
{
  "data": {
    "achievementUnlocked": {
      "acknowledged": false,
      "action": "abc123",
      "communityName": "abc123",
      "createdAtTime": "abc123",
      "id": 4,
      "source": BadgeSource
    }
  }
}

aiRequestUpdate

Description

Streams status/result updates for a single async AiRequest in real time.

Response

Returns an AiRequest

Arguments
Name Description
requestId - ID! public_id of the AiRequest to subscribe to.

Example

Query
subscription aiRequestUpdate($requestId: ID!) {
  aiRequestUpdate(requestId: $requestId) {
    completedAt
    createdAt
    errorCode
    errorMessage
    id
    kind
    resultJson
    status
    steps
  }
}
Variables
{"requestId": "4"}
Response
{
  "data": {
    "aiRequestUpdate": {
      "completedAt": ISO8601DateTime,
      "createdAt": ISO8601DateTime,
      "errorCode": "abc123",
      "errorMessage": "abc123",
      "id": "4",
      "kind": "abc123",
      "resultJson": "abc123",
      "status": "abc123",
      "steps": ["abc123"]
    }
  }
}

challengeCompleted

Description

Streams a user's own community challenge completions in real time.

Response

Returns a ChallengeParticipant

Arguments
Name Description
userId - ID! public_id of the user to subscribe to challenge completions for.

Example

Query
subscription challengeCompleted($userId: ID!) {
  challengeCompleted(userId: $userId) {
    communityChallenge {
      ...CommunityChallengeFragment
    }
    completed
    completedAt
    progressCount
    progressPercent
    publicId
    rank
    user {
      ...UserFragment
    }
    userPublicId
  }
}
Variables
{"userId": "4"}
Response
{
  "data": {
    "challengeCompleted": {
      "communityChallenge": CommunityChallenge,
      "completed": true,
      "completedAt": ISO8601DateTime,
      "progressCount": 987,
      "progressPercent": 987.65,
      "publicId": "4",
      "rank": 123,
      "user": User,
      "userPublicId": "abc123"
    }
  }
}

feedUpdate

Description

Streams a feed invalidation ping for a user in real time.

Response

Returns a FeedUpdatePayload

Arguments
Name Description
userId - ID! public_id of the user to subscribe to feed updates for.

Example

Query
subscription feedUpdate($userId: ID!) {
  feedUpdate(userId: $userId) {
    occurredAt
    source
  }
}
Variables
{"userId": "4"}
Response
{
  "data": {
    "feedUpdate": {
      "occurredAt": "abc123",
      "source": "abc123"
    }
  }
}

notificationUpdate

Description

Streams new notifications for a user in real time.

Response

Returns a UserNotification

Arguments
Name Description
userId - ID! public_id of the user to subscribe to notifications for.

Example

Query
subscription notificationUpdate($userId: ID!) {
  notificationUpdate(userId: $userId) {
    acknowledged
    content
    createdAtTime
    detailsJson
    id
    kind
  }
}
Variables
{"userId": "4"}
Response
{
  "data": {
    "notificationUpdate": {
      "acknowledged": false,
      "content": "xyz789",
      "createdAtTime": "xyz789",
      "detailsJson": "xyz789",
      "id": "4",
      "kind": "xyz789"
    }
  }
}

Types

AcceptAiAutonomyOfferPayload

Description

Autogenerated return type of AcceptAiAutonomyOffer.

Fields
Field Name Description
errors - [String!]!
offer - AiAutonomyOffer
Example
{
  "errors": ["xyz789"],
  "offer": AiAutonomyOffer
}

AcceptAllyInvitePayload

Description

Autogenerated return type of AcceptAllyInvite.

Fields
Field Name Description
errors - [String!]!
userAlly - UserAlly
Example
{
  "errors": ["abc123"],
  "userAlly": UserAlly
}

AcceptAllyRequestPayload

Description

Autogenerated return type of AcceptAllyRequest.

Fields
Field Name Description
errors - [String!]!
userAlly - UserAlly
Example
{
  "errors": ["xyz789"],
  "userAlly": UserAlly
}

AcceptHabitIntegrationMappingPayload

Description

Autogenerated return type of AcceptHabitIntegrationMapping.

Fields
Field Name Description
errors - [String!]!
mapping - HabitIntegrationMapping
Example
{
  "errors": ["abc123"],
  "mapping": HabitIntegrationMapping
}

AcceptPaceSuggestionPayload

Description

Autogenerated return type of AcceptPaceSuggestion.

Fields
Field Name Description
errors - [String!]!
goal - Goal
previousTargetDate - String ISO date string of the target date before this change — pass to updateGoal to undo.
proposedTargetDate - String ISO date string of the newly applied target date.
Example
{
  "errors": ["abc123"],
  "goal": Goal,
  "previousTargetDate": "abc123",
  "proposedTargetDate": "xyz789"
}

AcceptPartnerRequestPayload

Description

Autogenerated return type of AcceptPartnerRequest.

Fields
Field Name Description
errors - [String!]!
userAlly - UserAlly
Example
{
  "errors": ["xyz789"],
  "userAlly": UserAlly
}

AcceptStreakMercyPayload

Description

Autogenerated return type of AcceptStreakMercy.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

AcceptTeamInvitePayload

Description

Autogenerated return type of AcceptTeamInvite.

Fields
Field Name Description
communityCount - Int
errors - [String!]!
preselectedCommunityIds - [String!]
seatCapExceeded - Boolean! True only for the seat-cap-exhausted failure — the frontend shows SeatCapBlockerModal for this and nothing else.
team - Team The joined team — lets JoinTeamView set the active team scope (OBJ-1830).
teamMembership - TeamMembership
Example
{
  "communityCount": 123,
  "errors": ["abc123"],
  "preselectedCommunityIds": ["abc123"],
  "seatCapExceeded": false,
  "team": Team,
  "teamMembership": TeamMembership
}

AccountabilityPartner

Description

The current accountability partner for a user.

Fields
Field Name Description
accountabilityPartnerSince - ISO8601DateTime When the partnership was established.
cheerSentToday - Boolean! Whether the current user has already cheered this partner today, by any route (user-level, goal-scoped, or event-level), on the viewer's local day. False on the admin-viewing-another-user path, like nudgeSentToday.
firstName - String The partner user's given name.
lastName - String The partner user's family name.
longestMutualStreak - Int! All-time longest mutual streak between partners.
mutualStreakCount - Int! Current mutual check-in streak between partners.
mutualStreakLastDate - ISO8601Date Date of the most recent mutual bonus award.
nudgeSentToday - Boolean! Whether the current user has already sent a nudge to their partner today.
partnerCheckedInToday - Boolean! Whether the partner has checked in today.
photo - UserPhoto The partner user's profile photo.
publicId - ID! The partner user's public identifier.
recentActivity - [PartnerActivityItem!]! The partner's most recent check-ins and milestone hits visible to the viewer, newest first.
Arguments
limit - Int

Maximum items to return. Clamped to 1-3; defaults to 3.

userCheckedInToday - Boolean! Whether the current user has checked in today.
username - String The partner user's unique handle.
Example
{
  "accountabilityPartnerSince": ISO8601DateTime,
  "cheerSentToday": false,
  "firstName": "abc123",
  "lastName": "abc123",
  "longestMutualStreak": 123,
  "mutualStreakCount": 987,
  "mutualStreakLastDate": ISO8601Date,
  "nudgeSentToday": true,
  "partnerCheckedInToday": false,
  "photo": UserPhoto,
  "publicId": 4,
  "recentActivity": [PartnerActivityItem],
  "userCheckedInToday": false,
  "username": "xyz789"
}

AchievementStats

Description

Computed achievement and rank statistics for a user.

Fields
Field Name Description
currentLevel - Int! Actual XP level (1–10).
currentRankName - String! Rank name corresponding to the user's current level.
currentVolume - Int! Journey volume: 1 (levels 1–3), 2 (levels 4–6), 3 (level 7+).
currentXp - Int! Total XP earned by the user.
earnedCount - Int! Number of badges unlocked through action, excluding first_sign_in ("Day One") — the predicate the achievements empty-state UI gates on, since every signed-in user has Day One and unlocked_count alone can never reach 0 (OBJ-3879).
last7DaysXp - [Int!]! Daily XP earned for each of the last 7 days, oldest first.
nextRankName - String Rank name for the next level, or null at max level.
rarePlusCount - Int! Number of Rare, Epic, or Legendary badges the user has unlocked.
totalCount - Int! Total number of badges available.
unlockedCount - Int! Number of badges the user has unlocked.
xpToNextRank - Int XP needed to reach the next rank, or null at max level.
Example
{
  "currentLevel": 123,
  "currentRankName": "abc123",
  "currentVolume": 123,
  "currentXp": 987,
  "earnedCount": 987,
  "last7DaysXp": [987],
  "nextRankName": "abc123",
  "rarePlusCount": 987,
  "totalCount": 987,
  "unlockedCount": 123,
  "xpToNextRank": 123
}

AcknowledgeActionPayload

Description

Autogenerated return type of AcknowledgeAction.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

AcknowledgeAllNotificationsPayload

Description

Autogenerated return type of AcknowledgeAllNotifications.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

AcknowledgeChallengeCelebrationPayload

Description

Autogenerated return type of AcknowledgeChallengeCelebration.

Fields
Field Name Description
errors - [String!]!
participantId - ID public_id of the acknowledged challenge participant row.
Example
{"errors": ["abc123"], "participantId": 4}

AcknowledgeCollectiveGoalPrivacyContractPayload

Description

Autogenerated return type of AcknowledgeCollectiveGoalPrivacyContract.

Fields
Field Name Description
acknowledged - Boolean
errors - [String!]!
Example
{"acknowledged": true, "errors": ["xyz789"]}

AcknowledgeEncouragementCelebrationPayload

Description

Autogenerated return type of AcknowledgeEncouragementCelebration.

Fields
Field Name Description
celebrationId - ID public_id of the acknowledged celebration.
errors - [String!]!
moment - EncouragementMomentEnum Moment of the acknowledged celebration.
Example
{
  "celebrationId": "4",
  "errors": ["abc123"],
  "moment": "COMPLETED"
}

AcknowledgeNotificationPayload

Description

Autogenerated return type of AcknowledgeNotification.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

AcknowledgePactCelebrationPayload

Description

Autogenerated return type of AcknowledgePactCelebration.

Fields
Field Name Description
errors - [String!]!
pact - Pact
Example
{
  "errors": ["xyz789"],
  "pact": Pact
}

AcknowledgePactTakeoverPayload

Description

Autogenerated return type of AcknowledgePactTakeover.

Fields
Field Name Description
errors - [String!]!
pact - Pact
Example
{
  "errors": ["abc123"],
  "pact": Pact
}

AcknowledgeStreakRecountNotePayload

Description

Autogenerated return type of AcknowledgeStreakRecountNote.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": true}

ActivityItem

Description

Recent platform activity item

Fields
Field Name Description
action - String!
id - ID!
timestamp - String!
type - String!
userName - String!
Example
{
  "action": "xyz789",
  "id": "4",
  "timestamp": "xyz789",
  "type": "xyz789",
  "userName": "abc123"
}

AddAiAssignmentCommentPayload

Description

Autogenerated return type of AddAiAssignmentComment.

Fields
Field Name Description
comment - AiAssignmentComment
errors - [String!]!
run - AiRun The revision run this comment started, if any.
Example
{
  "comment": AiAssignmentComment,
  "errors": ["abc123"],
  "run": AiRun
}

AddCommunitySuggestionPayload

Description

Autogenerated return type of AddCommunitySuggestion.

Fields
Field Name Description
communitySuggestion - CommunitySuggestion
errors - [String!]!
Example
{
  "communitySuggestion": CommunitySuggestion,
  "errors": ["abc123"]
}

AddGoalEventCommentPayload

Description

Autogenerated return type of AddGoalEventComment.

Fields
Field Name Description
errors - [String!]!
goalEventComment - GoalEventComment
Example
{
  "errors": ["xyz789"],
  "goalEventComment": GoalEventComment
}

AddGoalEventPayload

Description

Autogenerated return type of AddGoalEvent.

Fields
Field Name Description
errors - [String!]!
goalEvent - GoalEvent
xpAwarded - Int Total XP this update awarded (streak bonus plus any badge, OBJ-5989). 0 when none; null on failure.
Example
{
  "errors": ["xyz789"],
  "goalEvent": GoalEvent,
  "xpAwarded": 123
}

AddGoalPayload

Description

Autogenerated return type of AddGoal.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

AddGoalToCommunityPayload

Description

Autogenerated return type of AddGoalToCommunity.

Fields
Field Name Description
communityGoal - CommunityGoal
errors - [String!]!
Example
{
  "communityGoal": CommunityGoal,
  "errors": ["abc123"]
}

AddMoodLogPayload

Description

Autogenerated return type of AddMoodLog.

Fields
Field Name Description
errors - [String!]!
moodLog - MoodLog
Example
{
  "errors": ["xyz789"],
  "moodLog": MoodLog
}

AddPostCommentPayload

Description

Autogenerated return type of AddPostComment.

Fields
Field Name Description
errors - [String!]!
postComment - PostComment
Example
{
  "errors": ["xyz789"],
  "postComment": PostComment
}

AddPracticePayload

Description

Autogenerated return type of AddPractice.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["abc123"],
  "goal": Goal
}

AdjustTeamSeatsPayload

Description

Autogenerated return type of AdjustTeamSeats.

Fields
Field Name Description
errors - [String!]!
teamSubscription - TeamSubscription
Example
{
  "errors": ["xyz789"],
  "teamSubscription": TeamSubscription
}

AdminAction

Description

A log of administrative actions performed globally.

Fields
Field Name Description
action - String! Legacy alias for actionType — retained for the pre-v1.7 GetRecentActions query.
actionType - String! Action category — e.g. demo_data_full_reseed, update_demo_user.
actor - User The admin user who performed this action. Null when the actor's own account was later deleted (OBJ-2215: the audit row is retained and anonymized rather than destroyed).
adminUser - User Legacy alias for actor — retained for the pre-v1.7 GetRecentActions query.
createdAt - String! ISO 8601 timestamp when the action was performed.
id - ID! Integer ID.
metadata - JSON Additional action details as JSON.
targetId - Int Raw polymorphic target DB ID — nullable alongside target_type. Prefer targetPublicId for display; this integer is retained for back-compat with the pre-v1.7 GetRecentActions query.
targetPublicId - ID Opaque public_id of the polymorphic target when it is a PublicRecord and still present. Null when the target has no public_id (non-PublicRecord reference table) or was deleted. Use this instead of targetId in UIs.
targetType - String Polymorphic target class — nullable for actions with no target (e.g. full demo-data reseed).
Example
{
  "action": "abc123",
  "actionType": "abc123",
  "actor": User,
  "adminUser": User,
  "createdAt": "abc123",
  "id": 4,
  "metadata": {},
  "targetId": 987,
  "targetPublicId": 4,
  "targetType": "abc123"
}

AdminActionConnection

Description

The connection type for AdminAction.

Fields
Field Name Description
edges - [AdminActionEdge] A list of edges.
nodes - [AdminAction] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [AdminActionEdge],
  "nodes": [AdminAction],
  "pageInfo": PageInfo
}

AdminActionEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AdminAction The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": AdminAction
}

AdminAiUsage

Description

Aggregated AI spend, usage, and budget utilization for the admin dashboard. Admin only.

Fields
Field Name Description
budgetCents - Int! Monthly budget ceiling from Settings.ai.monthly_budget_cents.
budgetUtilizationPercent - Float! Month-to-date spend as a percent of the monthly budget.
dailySeries - [DailyUsagePoint!]! Daily time series for the line chart (oldest → newest).
perFeature - [FeatureUsagePoint!]! Breakdown by feature, sorted by cost_cents DESC.
perModel - [ModelUsagePoint!]! Breakdown by model, sorted by cost_cents DESC.
perResolvedModel - [ResolvedModelUsagePoint!]! Breakdown by resolved model, sorted by cost_cents DESC.
totalCalls - Int! Count of AiUsageEvent rows over the selected window.
totalSpendCents - Int! Total AI spend in cents over the selected window.
totalTokens - Int! Sum of total_tokens over the selected window.
Example
{
  "budgetCents": 123,
  "budgetUtilizationPercent": 987.65,
  "dailySeries": [DailyUsagePoint],
  "perFeature": [FeatureUsagePoint],
  "perModel": [ModelUsagePoint],
  "perResolvedModel": [ResolvedModelUsagePoint],
  "totalCalls": 987,
  "totalSpendCents": 987,
  "totalTokens": 123
}

AdminCommunity

Description

Admin only. A community row for the /communities admin list, metadata only.

Fields
Field Name Description
archivedAt - ISO8601DateTime When this community began its archive window, or nil.
createdAt - ISO8601DateTime! ISO 8601 datetime when the community was created.
creatorName - String The earliest admin-role CommunityMember's display name, or nil when there isn't one.
demo - Boolean! Whether this community is a demo-tagged record (Phase 30).
discoverable - Boolean! True once membersCount reaches Community::DISCOVERY_THRESHOLD.
icon - String! Display icon key for a Team sub-community (sunrise/book/leaf/mountain/users).
imageUrl - String URL of the community avatar/icon image.
isTeam - Boolean! True when this community is a Team sub-community.
membersCount - Int! Total number of members in this community.
membersToDiscoverable - Int! Members still needed to appear in discovery (0 when discoverable).
name - String! Display name of the community.
private - Boolean! When true, membership requires an invite or approval.
publicId - ID! URL-safe public identifier for this community.
Example
{
  "archivedAt": ISO8601DateTime,
  "createdAt": ISO8601DateTime,
  "creatorName": "xyz789",
  "demo": false,
  "discoverable": false,
  "icon": "xyz789",
  "imageUrl": "abc123",
  "isTeam": false,
  "membersCount": 123,
  "membersToDiscoverable": 123,
  "name": "xyz789",
  "private": false,
  "publicId": "4"
}

AdminCommunityConnection

Description

The connection type for AdminCommunity.

Fields
Field Name Description
edges - [AdminCommunityEdge] A list of edges.
nodes - [AdminCommunity] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! Total number of items across all pages, respecting any filters already applied.
Example
{
  "edges": [AdminCommunityEdge],
  "nodes": [AdminCommunity],
  "pageInfo": PageInfo,
  "totalCount": 123
}

AdminCommunityEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AdminCommunity The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": AdminCommunity
}

AdminDashboardPin

Fields
Field Name Description
cardKey - String! daily_active_users | goal_themes | recent_activity.
createdAt - ISO8601DateTime!
id - ID!
pinnedVia - String!
Example
{
  "cardKey": "abc123",
  "createdAt": ISO8601DateTime,
  "id": "4",
  "pinnedVia": "xyz789"
}

AdminOnboardingStateEnum

Description

Derived onboarding state: the first onboarding funnel step the user has not reached.

Values
Enum Value Description

no_first_check_in

Has a goal but no check-in yet.

no_first_goal

Completed the wizard but has no goal yet.

onboarded

Reached every funnel step through the first check-in.

wizard_incomplete

Started the wizard but did not complete it.

wizard_not_started

Never started the onboarding wizard.
Example
"no_first_check_in"

AdminStats

Description

Admin statistics for platform monitoring

Fields
Field Name Description
completedGoals - Int!
criticalFlags - Int! Number of critical severity pending flags
goalCategories - [CategoryStats!]!
goalsLast7Days - Int!
growthData - [GrowthDataPoint!]!
monthlyActiveUsers - Int! Real users active in the last 30 days (including today)
pendingFlags - Int! Number of pending content moderation flags
pendingReports - Int! Number of pending user content reports
publicGoals - Int!
recentActivity - [ActivityItem!]!
supporterStats - SupporterStats! MRR and active supporter counts by tier
totalEncouragements - Int!
totalEvents - Int!
totalGoals - Int!
totalMilestones - Int!
totalUpdates - Int!
totalUsers - Int!
usersLast30Days - Int!
usersLast7Days - Int!
Example
{
  "completedGoals": 123,
  "criticalFlags": 123,
  "goalCategories": [CategoryStats],
  "goalsLast7Days": 987,
  "growthData": [GrowthDataPoint],
  "monthlyActiveUsers": 987,
  "pendingFlags": 123,
  "pendingReports": 123,
  "publicGoals": 987,
  "recentActivity": [ActivityItem],
  "supporterStats": SupporterStats,
  "totalEncouragements": 123,
  "totalEvents": 987,
  "totalGoals": 123,
  "totalMilestones": 987,
  "totalUpdates": 123,
  "totalUsers": 987,
  "usersLast30Days": 987,
  "usersLast7Days": 987
}

AdminTeamMonitoring

Description

Internal read-only monitoring row for a team (M11, PRIVACY-3). Admin-only. Carries no personal goal/mood/journal/coach data — seat and billing state only.

Fields
Field Name Description
lastActiveAt - ISO8601DateTime Most recent updated_at across the team's members. Null for an empty team.
seatCountUsed - Int! Current seat usage: total number of team memberships.
seatLimit - Int Seat limit from the subscription. Null if no subscription.
subscriptionStatus - String Raw TeamSubscription.status: trialing, active, past_due, grace, or canceled. Null if no subscription.
teamName - String! The team name.
teamPublicId - String! The team public_id.
Example
{
  "lastActiveAt": ISO8601DateTime,
  "seatCountUsed": 987,
  "seatLimit": 987,
  "subscriptionStatus": "xyz789",
  "teamName": "abc123",
  "teamPublicId": "xyz789"
}

AdminUserConnection

Description

The connection type for User.

Fields
Field Name Description
edges - [UserEdge] A list of edges.
nodes - [User] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
totalCount - Int! Total number of users matching the active query and filter, independent of pagination.
Example
{
  "edges": [UserEdge],
  "nodes": [User],
  "pageInfo": PageInfo,
  "totalCount": 987
}

AdminUserFilter

Description

Admin-only structured filter for adminSearchUsers. All fields are optional and AND together.

Fields
Input Field Description
onboardingState - AdminOnboardingStateEnum
role - String An admin role the user holds (super_admin, admin, support, ...).
signedUpAfter - ISO8601Date Users who signed up on or after this date.
Example
{
  "onboardingState": "no_first_check_in",
  "role": "abc123",
  "signedUpAfter": ISO8601Date
}

AdminUserSegment

Fields
Field Name Description
createdAt - ISO8601DateTime!
filter - AdminUserSegmentFilter!
id - ID!
name - String!
Example
{
  "createdAt": ISO8601DateTime,
  "filter": AdminUserSegmentFilter,
  "id": 4,
  "name": "abc123"
}

AdminUserSegmentFilter

Fields
Field Name Description
onboardingState - String
role - String
signedUpAfter - ISO8601Date
Example
{
  "onboardingState": "abc123",
  "role": "abc123",
  "signedUpAfter": ISO8601Date
}

AiArtifact

Fields
Field Name Description
aiRun - AiRun!
approvalStatus - String!
claimedAt - ISO8601DateTime
claimedByName - String The claiming teammate's display name; may fall back to their username. Never their id or email.
createdAt - ISO8601DateTime!
deliveredAt - ISO8601DateTime
deliveryMetadata - JSON
deliveryStatus - [AiDeliveryChannelStatus!]! Per-channel Buffer state for approved social posts.
editDistance - Float
featureImage - FeatureImage A blog_post's proposed or reviewer-chosen hero image, resolved from its design_asset_id. Null when there is none, or the asset is gone.
ghostEditorUrl - String An approved blog_post's editor link in Ghost. Only an https URL is ever returned.
id - String!
kind - String!
payload - JSON!
postFilterStatus - String The brand-voice post-filter outcome: passed, skipped (a filter is configured but could not judge the artifact) or failed. Null when no filter ran, including artifacts created before this was recorded.
rejectionReason - String
reviewedAt - ISO8601DateTime When the artifact was last approved, rejected, or sent back for changes. Can stay set after a failed revision reopens the artifact to pending, so it does not by itself mean decided.
reviewedBy - AiArtifactReviewer
reviewerFeedback - String The reviewer's note when they asked for changes. Kept on the original and its revision.
revisionNumber - Int! 1 for the original, +1 per revisionOf hop.
revisionOf - AiArtifact The artifact this one revises.
revisions - [AiArtifact!]! Revisions made after changes were requested, oldest first.
scheduledFor - ISO8601DateTime When the reviewer wants the Buffer draft to go out. Still a draft.
title - String
undoableUntil - ISO8601DateTime When the undo grace window closes. Null once it has, once delivery has started, or if the artifact was never approved.
Example
{
  "aiRun": AiRun,
  "approvalStatus": "xyz789",
  "claimedAt": ISO8601DateTime,
  "claimedByName": "abc123",
  "createdAt": ISO8601DateTime,
  "deliveredAt": ISO8601DateTime,
  "deliveryMetadata": {},
  "deliveryStatus": [AiDeliveryChannelStatus],
  "editDistance": 987.65,
  "featureImage": FeatureImage,
  "ghostEditorUrl": "xyz789",
  "id": "xyz789",
  "kind": "abc123",
  "payload": {},
  "postFilterStatus": "abc123",
  "rejectionReason": "abc123",
  "reviewedAt": ISO8601DateTime,
  "reviewedBy": AiArtifactReviewer,
  "reviewerFeedback": "abc123",
  "revisionNumber": 987,
  "revisionOf": AiArtifact,
  "revisions": [AiArtifact],
  "scheduledFor": ISO8601DateTime,
  "title": "xyz789",
  "undoableUntil": ISO8601DateTime
}

AiArtifactBulkResult

Description

The outcome for one artifact in a bulk approve.

Fields
Field Name Description
artifactId - String!
error - String
success - Boolean!
Example
{
  "artifactId": "xyz789",
  "error": "xyz789",
  "success": true
}

AiArtifactConnection

Description

The connection type for AiArtifact.

Fields
Field Name Description
edges - [AiArtifactEdge] A list of edges.
nodes - [AiArtifact] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [AiArtifactEdge],
  "nodes": [AiArtifact],
  "pageInfo": PageInfo
}

AiArtifactCounts

Description

How many of a run's artifacts sit in each review state.

Fields
Field Name Description
approved - Int!
autoRejected - Int!
changesRequested - Int!
pending - Int!
rejected - Int!
Example
{
  "approved": 123,
  "autoRejected": 987,
  "changesRequested": 123,
  "pending": 987,
  "rejected": 123
}

AiArtifactEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AiArtifact The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": AiArtifact
}

AiArtifactReviewer

Description

The person who reviewed an artifact. Name only, so nothing else about the user is exposed.

Fields
Field Name Description
name - String!
Example
{"name": "xyz789"}

AiAsset

Fields
Field Name Description
aiArtifact - AiArtifact The artifact this image was attached to, once the run has produced one.
aiEmployee - AiEmployee!
createdAt - ISO8601DateTime!
height - Int!
id - String!
layout - String!
url - String
width - Int!
Example
{
  "aiArtifact": AiArtifact,
  "aiEmployee": AiEmployee,
  "createdAt": ISO8601DateTime,
  "height": 987,
  "id": "abc123",
  "layout": "xyz789",
  "url": "abc123",
  "width": 987
}

AiAssignment

Description

One logical task an AI agent owns. Groups its runs, including retries and revisions.

Fields
Field Name Description
chatSession - AiChatSession Set when source is 'chat' — the conversation it was drafted from.
comments - [AiAssignmentComment!]! The thread, oldest first.
createdAt - ISO8601DateTime!
createdBy - AiRunRequester Who created it, when a person did. Name only.
description - String
id - String!
owner - AiEmployee! The agent that owns this assignment.
parent - AiAssignment
runs - [AiRun!]! Every run for this assignment, oldest first.
source - String! schedule, autopilot, manual, event or chat.
status - String! todo, working, waiting_on_admin, done or cancelled. Derived from its runs and artifacts.
title - String
updatedAt - ISO8601DateTime!
Example
{
  "chatSession": AiChatSession,
  "comments": [AiAssignmentComment],
  "createdAt": ISO8601DateTime,
  "createdBy": AiRunRequester,
  "description": "abc123",
  "id": "abc123",
  "owner": AiEmployee,
  "parent": AiAssignment,
  "runs": [AiRun],
  "source": "abc123",
  "status": "xyz789",
  "title": "xyz789",
  "updatedAt": ISO8601DateTime
}

AiAssignmentComment

Description

One message in an assignment thread (OBJ-5712). Authored by either a staff member or the agent.

Fields
Field Name Description
artifact - AiArtifact The pinned artifact, if any.
authorAgent - AiEmployee Set when the agent wrote this — its own reply.
authorUser - AiRunRequester Set when a staff member wrote this.
body - String!
createdAt - ISO8601DateTime!
id - String!
kind - String! comment, change_request or approval_note.
pickupState - String! picked_up, folded, waiting or not_waking. What happened to this comment.
revisionRun - AiRun The run that consumed this comment, if any.
Example
{
  "artifact": AiArtifact,
  "authorAgent": AiEmployee,
  "authorUser": AiRunRequester,
  "body": "abc123",
  "createdAt": ISO8601DateTime,
  "id": "abc123",
  "kind": "xyz789",
  "pickupState": "xyz789",
  "revisionRun": AiRun
}

AiAssignmentConnection

Description

The connection type for AiAssignment.

Fields
Field Name Description
edges - [AiAssignmentEdge] A list of edges.
nodes - [AiAssignment] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [AiAssignmentEdge],
  "nodes": [AiAssignment],
  "pageInfo": PageInfo
}

AiAssignmentEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AiAssignment The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": AiAssignment
}

AiAutonomyOffer

Description

One offer to switch a (agent, output kind) pair to a higher autonomy level (OBJ-5769, v4.98 Phase 9).

Fields
Field Name Description
createdAt - ISO8601DateTime!
evidence - AiAutonomyOfferEvidence!
id - String!
kind - String!
status - String!
targetLevel - String!
Example
{
  "createdAt": ISO8601DateTime,
  "evidence": AiAutonomyOfferEvidence,
  "id": "abc123",
  "kind": "xyz789",
  "status": "xyz789",
  "targetLevel": "abc123"
}

AiAutonomyOfferEvidence

Description

The snapshot of track-record numbers an offer was made against (OBJ-5769, v4.98 Phase 9).

Fields
Field Name Description
approvalRate - Float approved / decided, like AiEmployeeStatsType#approvalRate.
decided - Int
windowWeeks - Int
Example
{"approvalRate": 987.65, "decided": 123, "windowWeeks": 987}

AiAutopilot

Description

A scheduled instruction for an AI employee. An agent can have many, each on its own schedule and time zone.

Fields
Field Name Description
active - Boolean!
aiEmployee - AiEmployee!
cooldownSeconds - Int!
eventKind - String
filter - JSON! Event-matching keys for event autopilots; always {} on scheduled ones.
id - String!
instructions - String!
lastRun - AiRun The most recent run, including runs that were skipped.
lastRunAt - ISO8601DateTime
name - String!
nextRunAt - ISO8601DateTime UTC. Null while paused.
postsPerRun - Int
scheduleCron - String! Five-field cron. Empty string for event-triggered autopilots.
timeZone - String! IANA time zone the schedule is read in, e.g. America/Chicago.
triggerType - String! schedule or event.
Example
{
  "active": true,
  "aiEmployee": AiEmployee,
  "cooldownSeconds": 123,
  "eventKind": "abc123",
  "filter": {},
  "id": "xyz789",
  "instructions": "xyz789",
  "lastRun": AiRun,
  "lastRunAt": ISO8601DateTime,
  "name": "xyz789",
  "nextRunAt": ISO8601DateTime,
  "postsPerRun": 987,
  "scheduleCron": "abc123",
  "timeZone": "abc123",
  "triggerType": "xyz789"
}

AiChatMessage

Description

One message in a chat session thread (OBJ-5714). Authored by either the owner or the agent.

Fields
Field Name Description
authorAgent - AiEmployee Set when the agent wrote this — its own reply.
authorUser - AiRunRequester Set when the owner wrote this.
body - String!
createdAssignment - AiAssignment The task confirmed from this message's draft, if any (agent drafts only).
createdAt - ISO8601DateTime!
id - String!
kind - String! message or task_draft_request.
pickupState - String! picked_up, folded, waiting, not_waking or failed. User messages only (always not_waking for agent messages).
run - AiRun The run that consumed this message (user) or produced it (agent).
taskDraft - AiChatTaskDraft Agent messages only.
Example
{
  "authorAgent": AiEmployee,
  "authorUser": AiRunRequester,
  "body": "xyz789",
  "createdAssignment": AiAssignment,
  "createdAt": ISO8601DateTime,
  "id": "abc123",
  "kind": "xyz789",
  "pickupState": "abc123",
  "run": AiRun,
  "taskDraft": AiChatTaskDraft
}

AiChatSession

Description

A conversation between an admin and one AI employee (OBJ-5713/5714), owned by whoever started it.

Fields
Field Name Description
activeRunStatus - String queued, running or null.
agent - AiEmployee!
assignments - [AiAssignment!]! Tasks confirmed from this conversation.
costCents - Int! Summed from this session's runs.
createdAt - ISO8601DateTime!
id - String!
lastMessageAt - ISO8601DateTime
messages - [AiChatMessage!]! Oldest first.
title - String Set from the first message, truncated.
viewerIsOwner - Boolean! True when the current admin started this conversation.
Example
{
  "activeRunStatus": "xyz789",
  "agent": AiEmployee,
  "assignments": [AiAssignment],
  "costCents": 987,
  "createdAt": ISO8601DateTime,
  "id": "xyz789",
  "lastMessageAt": ISO8601DateTime,
  "messages": [AiChatMessage],
  "title": "abc123",
  "viewerIsOwner": true
}

AiChatTaskDraft

Description

A drafted task title/description from a chat reply (OBJ-5714), before it becomes an assignment (10.3).

Fields
Field Name Description
description - String!
title - String!
Example
{
  "description": "xyz789",
  "title": "abc123"
}

AiDeliveryChannelStatus

Description

Where one channel of an approved post stands with its delivery destination — Buffer for a social post, Ghost for a blog article.

Fields
Field Name Description
channel - String!
permanent - Boolean! True when a failure will not retry on its own. A reviewer has to retry it.
reason - AiDeliveryFailureReason Why a failure happened, when the cause is known. Never inferred from the error text.
state - AiDeliveryState!
Example
{
  "channel": "xyz789",
  "permanent": true,
  "reason": "IMAGE_UPLOAD_FAILED",
  "state": "FAILED"
}

AiDeliveryFailureReason

Values
Enum Value Description

IMAGE_UPLOAD_FAILED

The blog's feature image didn't upload to Ghost. Not permanent — retrying can succeed.

NOT_CONFIGURED

The destination isn't configured yet (for example, no Ghost admin key).
Example
"IMAGE_UPLOAD_FAILED"

AiDeliveryState

Values
Enum Value Description

FAILED

The draft did not land at its destination.

PENDING

Not sent yet, or still retrying.

SAVED

A draft is waiting at its destination (Buffer or Ghost).
Example
"FAILED"

AiEmployee

Fields
Field Name Description
active - Boolean!
aiEmployeeMemories - [AiEmployeeMemory!]!
aiRuns - [AiRun!]!
Arguments
limit - Int
offset - Int
approvalRateData - [ApprovalRateData!]!
archived - Boolean! True once the agent has been archived. Its run history stays visible.
autonomyLevel - String!
channels - [String!]!
crew - String
currentMonthCost - Int!
description - String
dispatchBlockReason - String Why a run cannot start right now: agent_archived, agent_paused, over_budget or crew_ceiling. Null when it can.
id - String!
lastRun - AiRun
mcpServers - [String!]!
modelPreference - String
monthlyBudgetCents - Int!
name - String!
nextRunAt - ISO8601DateTime
nextTrigger - AiEmployeeNextTrigger Earliest of the agent cron and its active schedule autopilots. Null when neither is set.
outputKind - String
postFilterSkill - String
postPerformance - PostPerformance Sent-post metrics summary (social agents); null until measured.
promotionCriteria - PromotionCriteria
roleKey - String!
scheduleCron - String
skillRefs - [String!]!
stats - AiEmployeeStats!
Arguments
days - Int
taskPrompt - String
Example
{
  "active": true,
  "aiEmployeeMemories": [AiEmployeeMemory],
  "aiRuns": [AiRun],
  "approvalRateData": [ApprovalRateData],
  "archived": false,
  "autonomyLevel": "abc123",
  "channels": ["abc123"],
  "crew": "xyz789",
  "currentMonthCost": 987,
  "description": "abc123",
  "dispatchBlockReason": "abc123",
  "id": "xyz789",
  "lastRun": AiRun,
  "mcpServers": ["xyz789"],
  "modelPreference": "abc123",
  "monthlyBudgetCents": 123,
  "name": "abc123",
  "nextRunAt": ISO8601DateTime,
  "nextTrigger": AiEmployeeNextTrigger,
  "outputKind": "xyz789",
  "postFilterSkill": "xyz789",
  "postPerformance": PostPerformance,
  "promotionCriteria": PromotionCriteria,
  "roleKey": "xyz789",
  "scheduleCron": "abc123",
  "skillRefs": ["xyz789"],
  "stats": AiEmployeeStats,
  "taskPrompt": "abc123"
}

AiEmployeeConnection

Description

The connection type for AiEmployee.

Fields
Field Name Description
edges - [AiEmployeeEdge] A list of edges.
nodes - [AiEmployee] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [AiEmployeeEdge],
  "nodes": [AiEmployee],
  "pageInfo": PageInfo
}

AiEmployeeEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AiEmployee The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": AiEmployee
}

AiEmployeeMemory

Fields
Field Name Description
id - String!
memoryData - JSON
memoryKey - String!
updatedAt - ISO8601DateTime!
Example
{
  "id": "abc123",
  "memoryData": {},
  "memoryKey": "abc123",
  "updatedAt": ISO8601DateTime
}

AiEmployeeNextTrigger

Description

The earliest upcoming run this agent is scheduled for, across its own cron and its autopilots.

Fields
Field Name Description
at - ISO8601DateTime!
name - String The autopilot's name. Null for an agent_cron trigger.
source - String! agent_cron or autopilot.
Example
{
  "at": ISO8601DateTime,
  "name": "xyz789",
  "source": "abc123"
}

AiEmployeeStats

Description

Aggregate run/approval/spend stats over a trailing window (AiWorkforce::AgentStats).

Fields
Field Name Description
approvalRate - Float approved / decided. Null when decided is 0.
approved - Int!
avgDurationSeconds - Int Averaged over finished runs.
blocked - Int! failure_reason: 'blocked'. Counted inside finished too.
budgetCents - Int! Monthly budget — not windowed.
decided - Int! Artifacts in AiArtifact::REVIEWED_STATUSES.
finished - Int! succeeded, or failed excluding over_budget/interrupted failure reasons.
interrupted - Int! failure_reason: 'interrupted'. Excluded from finished.
runs - Int! finished + running runs in the window. Never counts skipped.
spendCents - Int! The window's run cost.
succeeded - Int!
successRate - Float succeeded / finished. Null when finished is 0.
Example
{
  "approvalRate": 123.45,
  "approved": 123,
  "avgDurationSeconds": 987,
  "blocked": 123,
  "budgetCents": 123,
  "decided": 123,
  "finished": 987,
  "interrupted": 123,
  "runs": 123,
  "spendCents": 987,
  "succeeded": 987,
  "successRate": 987.65
}

AiInboxCounts

Description

Inbox header counts for the current viewer.

Fields
Field Name Description
actionable - Int! Unarchived, unresolved, actionable items -- same definition as pendingCounts.workforceInbox.
byType - [AiInboxTypeCount!]! Every currently visible (unarchived) item, resolved or not, grouped by type.
Example
{"actionable": 987, "byType": [AiInboxTypeCount]}

AiInboxItem

Description

A typed AI Workforce inbox item, derived at read time from an ai_workforce_events row plus current run/artifact/assignment state (OBJ-5732). Never stored itself -- only its archive state persists.

Fields
Field Name Description
actionable - Boolean!
aiArtifact - AiArtifact
aiAssignment - AiAssignment
aiAutonomyOffer - AiAutonomyOffer Set only for an offer item (OBJ-5769, v4.98 Phase 9).
aiEmployee - AiEmployee!
aiRun - AiRun!
archived - Boolean!
createdAt - ISO8601DateTime!
headline - String!
id - String!
resolved - Boolean!
type - String! assigned, waiting, failed, delivered, replied or offer.
Example
{
  "actionable": false,
  "aiArtifact": AiArtifact,
  "aiAssignment": AiAssignment,
  "aiAutonomyOffer": AiAutonomyOffer,
  "aiEmployee": AiEmployee,
  "aiRun": AiRun,
  "archived": false,
  "createdAt": ISO8601DateTime,
  "headline": "abc123",
  "id": "xyz789",
  "resolved": true,
  "type": "xyz789"
}

AiInboxItemConnection

Description

The connection type for AiInboxItem.

Fields
Field Name Description
edges - [AiInboxItemEdge] A list of edges.
nodes - [AiInboxItem] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [AiInboxItemEdge],
  "nodes": [AiInboxItem],
  "pageInfo": PageInfo
}

AiInboxItemEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AiInboxItem The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": AiInboxItem
}

AiInboxTypeCount

Description

How many currently visible (unarchived) inbox items of one type the viewer has.

Fields
Field Name Description
count - Int!
type - String!
Example
{"count": 123, "type": "abc123"}

AiRequest

Fields
Field Name Description
completedAt - ISO8601DateTime
createdAt - ISO8601DateTime!
errorCode - String
errorMessage - String
id - ID!
kind - String!
resultJson - String
status - String!
steps - [String!]!
Example
{
  "completedAt": ISO8601DateTime,
  "createdAt": ISO8601DateTime,
  "errorCode": "xyz789",
  "errorMessage": "abc123",
  "id": "4",
  "kind": "xyz789",
  "resultJson": "abc123",
  "status": "xyz789",
  "steps": ["xyz789"]
}

AiRun

Fields
Field Name Description
aiArtifacts - [AiArtifact!]!
aiEmployee - AiEmployee!
artifactCounts - AiArtifactCounts!
assignment - AiAssignment
autoRetry - AiRun This run's automatic retry, if one was made.
autopilot - AiAutopilot The autopilot that fired this run, if any.
completionTokens - Int!
costCents - Int!
createdAt - ISO8601DateTime!
dueOn - ISO8601Date
durationSeconds - Int
errorMessage - String
failureReason - String max_turns, over_budget, interrupted, blocked or other. Failed runs only.
finishedAt - ISO8601DateTime
id - String!
instructions - String
numTurns - Int
promptTokens - Int!
requestedBy - AiRunRequester The person who asked for this run. Null for scheduled runs.
retryOf - AiRun The failed run this one automatically retried.
runLog - JSON
skipReason - String agent_paused, over_budget or agent_archived. Set only on skipped runs.
startedAt - ISO8601DateTime
status - String!
steps - [AiRunStep!] Per-step transcript (OBJ-5682). Null for runs recorded before this shipped.
title - String
triggeredBy - String!
Example
{
  "aiArtifacts": [AiArtifact],
  "aiEmployee": AiEmployee,
  "artifactCounts": AiArtifactCounts,
  "assignment": AiAssignment,
  "autoRetry": AiRun,
  "autopilot": AiAutopilot,
  "completionTokens": 987,
  "costCents": 123,
  "createdAt": ISO8601DateTime,
  "dueOn": ISO8601Date,
  "durationSeconds": 987,
  "errorMessage": "abc123",
  "failureReason": "xyz789",
  "finishedAt": ISO8601DateTime,
  "id": "xyz789",
  "instructions": "xyz789",
  "numTurns": 987,
  "promptTokens": 987,
  "requestedBy": AiRunRequester,
  "retryOf": AiRun,
  "runLog": {},
  "skipReason": "xyz789",
  "startedAt": ISO8601DateTime,
  "status": "xyz789",
  "steps": [AiRunStep],
  "title": "abc123",
  "triggeredBy": "xyz789"
}

AiRunConnection

Description

The connection type for AiRun.

Fields
Field Name Description
edges - [AiRunEdge] A list of edges.
nodes - [AiRun] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [AiRunEdge],
  "nodes": [AiRun],
  "pageInfo": PageInfo
}

AiRunEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AiRun The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": AiRun
}

AiRunRequester

Description

The staff member who asked for an AI run. Name only, so nothing else about the user is exposed.

Fields
Field Name Description
name - String!
Example
{"name": "xyz789"}

AiRunStep

Description

One step of a run's transcript: an assistant text/thinking block, or a tool call with its result folded in.

Fields
Field Name Description
costCents - Int! run.cost_cents apportioned by this step's token share (largest-remainder rounding).
durationMs - Int
index - Int
inputPreview - String Present on tool_call steps only.
inputTokens - Int!
isError - Boolean Present on tool_call steps only.
kind - String! text, thinking, tool_call, or truncated (the 200-step cap marker).
omitted - Int Present on the truncated sentinel only: how many steps beyond the 200-step cap were dropped.
outputPreview - String Present on tool_call steps only.
outputTokens - Int!
startedAt - ISO8601DateTime
tool - String Present on tool_call steps only.
turn - Int The assistant message index this step belongs to.
Example
{
  "costCents": 987,
  "durationMs": 987,
  "index": 123,
  "inputPreview": "abc123",
  "inputTokens": 123,
  "isError": true,
  "kind": "xyz789",
  "omitted": 123,
  "outputPreview": "abc123",
  "outputTokens": 123,
  "startedAt": ISO8601DateTime,
  "tool": "abc123",
  "turn": 987
}

AiTriggerEventFilterField

Description

One filter key an event-triggered autopilot can match on, from AiAutopilot::EVENT_FILTER_SCHEMAS.

Fields
Field Name Description
allowedValues - [String!] Allowed values, or null when any value is accepted.
key - String!
required - Boolean!
type - String! string or string_array.
Example
{
  "allowedValues": ["abc123"],
  "key": "xyz789",
  "required": false,
  "type": "xyz789"
}

AiTriggerEventKind

Description

An event kind an autopilot can trigger on, with the filter shape the server validates against.

Fields
Field Name Description
filterFields - [AiTriggerEventFilterField!]!
kind - String! e.g. feedback_post.created.
label - String!
Example
{
  "filterFields": [AiTriggerEventFilterField],
  "kind": "abc123",
  "label": "xyz789"
}

AiWorkforceEvent

Fields
Field Name Description
actor - AiRunRequester
actorKind - String!
aiArtifact - AiArtifact
aiEmployee - AiEmployee!
aiRun - AiRun!
createdAt - ISO8601DateTime!
id - String!
kind - String!
metadata - JSON!
Example
{
  "actor": AiRunRequester,
  "actorKind": "xyz789",
  "aiArtifact": AiArtifact,
  "aiEmployee": AiEmployee,
  "aiRun": AiRun,
  "createdAt": ISO8601DateTime,
  "id": "xyz789",
  "kind": "abc123",
  "metadata": {}
}

AiWorkforceEventConnection

Description

The connection type for AiWorkforceEvent.

Fields
Field Name Description
edges - [AiWorkforceEventEdge] A list of edges.
nodes - [AiWorkforceEvent] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [AiWorkforceEventEdge],
  "nodes": [AiWorkforceEvent],
  "pageInfo": PageInfo
}

AiWorkforceEventEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - AiWorkforceEvent The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": AiWorkforceEvent
}

AllyActivity

Description

A recent progress event from an accepted ally (friend), shown in the ally activity feed.

Fields
Field Name Description
action - String! Verb describing what the ally did (e.g. "checked in on").
allyId - ID public_id of the ally user who performed the action.
allyName - String! Display name of the ally user.
allyPhoto - String Profile photo URL of the ally user.
communityId - ID public_id of the community involved, if any.
communityName - String Name of the community involved, if any.
details - JSON Per-kind display payload; keys vary by kind.
id - ID! Public identifier for this activity record.
kind - AllyActivityKindEnum Activity kind discriminator: JOIN, POST, ACHIEVEMENT, GOAL, or FOLLOW.
loggedLate - Boolean! True when the entry was logged after its day. Boolean only, no day count.
target - String! Name of the goal the ally acted on.
timestamp - String! Unix timestamp (string) when the activity occurred.
Example
{
  "action": "abc123",
  "allyId": 4,
  "allyName": "abc123",
  "allyPhoto": "xyz789",
  "communityId": 4,
  "communityName": "xyz789",
  "details": {},
  "id": "4",
  "kind": "ACHIEVEMENT",
  "loggedLate": false,
  "target": "xyz789",
  "timestamp": "abc123"
}

AllyActivityKindEnum

Description

Discriminator for which activity-kind branch an ally feed row represents.

Values
Enum Value Description

ACHIEVEMENT

Ally completed a milestone on a goal.

FOLLOW

Ally added a new ally.

GOAL

Ally checked in on a goal or habit.

JOIN

Ally joined a community.

POST

Ally posted in a community.
Example
"ACHIEVEMENT"

AllyInvite

Description

An accountability-partner invite token generated by a user.

Fields
Field Name Description
createdAt - ISO8601DateTime! When the invite was created.
expiresAt - ISO8601DateTime! When this invite expires (7 days from creation).
id - ID! Public identifier for this invite record.
status - String! Current status: pending, accepted, expired, or revoked.
token - String! URL-safe invite token — embed in the deep link.
Example
{
  "createdAt": ISO8601DateTime,
  "expiresAt": ISO8601DateTime,
  "id": "4",
  "status": "abc123",
  "token": "abc123"
}

AllyInvitePreview

Description

Minimal public preview of an accountability-partner invite — safe for unauthenticated access.

Fields
Field Name Description
invalidReason - String Why the invite is invalid: 'expired', 'revoked', or 'not_found'. Null when valid is true.
inviterAvatarUrl - String URL for the inviter's profile photo, or null if none.
inviterName - String The inviter's display name.
valid - Boolean! Whether the invite is active and can be accepted.
Example
{
  "invalidReason": "xyz789",
  "inviterAvatarUrl": "abc123",
  "inviterName": "xyz789",
  "valid": false
}

AllyStatusEnum

Description

Relationship status between the searching user and a search result user.

Values
Enum Value Description

ACCEPTED

An active ally relationship exists in either direction.

BLOCKED

Current user has blocked this user.

NONE

No ally relationship exists.

PENDING_INCOMING

This user sent a pending ally request to the current user.

PENDING_OUTGOING

Current user sent a pending ally request to this user.
Example
"ACCEPTED"

AllySuggestion

Description

A user suggested as a potential ally, with a human-readable rationale.

Fields
Field Name Description
allyStatus - AllyStatusEnum! Relationship status — always NONE for suggestions.
firstName - String The user's given name.
lastName - String The user's family name.
mutualCount - Int! Number of communities shared with the current user.
photo - UserPhoto The user's profile photo.
publicId - String! URL-safe public identifier of the suggested user.
reason - String Short rationale, e.g. "Both in Marathon in 16 weeks".
username - String The user's unique handle.
Example
{
  "allyStatus": "ACCEPTED",
  "firstName": "xyz789",
  "lastName": "abc123",
  "mutualCount": 123,
  "photo": UserPhoto,
  "publicId": "abc123",
  "reason": "abc123",
  "username": "abc123"
}

AnalyticsActivityHeatmap

Description

Personal Analytics: trailing 90-day activity heatmap.

Fields
Field Name Description
days - [AnalyticsHeatmapDay!]!
Example
{"days": [AnalyticsHeatmapDay]}

AnalyticsCategoryCompletion

Description

Personal Analytics: one category's completion % for the current month-to-date.

Fields
Field Name Description
category - String! Goal category name ("Other" for folded overflow).
pct - Float! Percent of that category's goals done this period (0–100).
Example
{"category": "abc123", "pct": 123.45}

AnalyticsCompletionByCategory

Description

Personal Analytics: Completion-by-category chart series.

Fields
Field Name Description
series - [AnalyticsCategoryCompletion!]!
Example
{"series": [AnalyticsCategoryCompletion]}

AnalyticsHeatmapDay

Description

Personal Analytics: one day of the activity heatmap.

Fields
Field Name Description
count - Int! Number of activity actions on this date.
date - String! ISO8601 date.
Example
{"count": 987, "date": "abc123"}

AnalyticsMonthInReview

Description

Personal Analytics: the Month-in-review hero card.

Fields
Field Name Description
bestCategory - AnalyticsCategoryCompletion The leading category this period, or null with no data.
bestStreak - Int! Peak streak length achieved this month-to-date.
daysActive - Int! Distinct days with activity this month-to-date.
daysInMonth - Int! Total days in the current month.
goalsDone - Int! Goals completed this month-to-date.
xpEarned - Int! XP earned this month-to-date (from the XP ledger).
Example
{
  "bestCategory": AnalyticsCategoryCompletion,
  "bestStreak": 123,
  "daysActive": 123,
  "daysInMonth": 123,
  "goalsDone": 123,
  "xpEarned": 123
}

AnalyticsStreakHistory

Description

Personal Analytics: trailing 26-week streak history.

Fields
Field Name Description
currentRun - Int! The user's current active streak.
points - [AnalyticsStreakPoint!]!
Example
{"currentRun": 123, "points": [AnalyticsStreakPoint]}

AnalyticsStreakPoint

Description

Personal Analytics: streak length as of one week-start.

Fields
Field Name Description
date - String! ISO8601 date (week start).
length - Int! Streak length as of this date.
Example
{"date": "abc123", "length": 987}

AnalyticsXpOverTime

Description

Personal Analytics: trailing 26-week cumulative XP.

Fields
Field Name Description
points - [AnalyticsXpPoint!]!
Example
{"points": [AnalyticsXpPoint]}

AnalyticsXpPoint

Description

Personal Analytics: cumulative XP as of one week-start.

Fields
Field Name Description
date - String! ISO8601 date (week start).
xp - Int! Cumulative XP as of this date.
Example
{"date": "xyz789", "xp": 123}

AnswerInput

Description

A single forced-choice answer in an Enneagram assessment.

Fields
Input Field Description
choice - String! Selected option: "a" (first statement) or "b" (second statement).
pairIndex - Int! Zero-based index of the question pair (0..39).
Example
{"choice": "xyz789", "pairIndex": 123}

ApplyCoachProposalPayload

Description

Autogenerated return type of ApplyCoachProposal.

Fields
Field Name Description
coachProposal - CoachProposal The proposal after the call; null if it does not exist for this user.
errors - [String!]!
Example
{
  "coachProposal": CoachProposal,
  "errors": ["abc123"]
}

ApprovalRateData

Fields
Field Name Description
approvedCount - Int!
autoRejectedCount - Int!
rejectedCount - Int!
weekStart - String!
Example
{
  "approvedCount": 123,
  "autoRejectedCount": 987,
  "rejectedCount": 123,
  "weekStart": "abc123"
}

ApproveAiArtifactPayload

Description

Autogenerated return type of ApproveAiArtifact.

Fields
Field Name Description
artifact - AiArtifact
errors - [String!]!
Example
{
  "artifact": AiArtifact,
  "errors": ["xyz789"]
}

ApproveAiArtifactsPayload

Description

Autogenerated return type of ApproveAiArtifacts.

Fields
Field Name Description
errors - [String!]!
results - [AiArtifactBulkResult!]!
Example
{
  "errors": ["xyz789"],
  "results": [AiArtifactBulkResult]
}

ArchiveAiAutopilotPayload

Description

Autogenerated return type of ArchiveAiAutopilot.

Fields
Field Name Description
archivedAutopilotId - String
errors - [String!]!
Example
{
  "archivedAutopilotId": "abc123",
  "errors": ["xyz789"]
}

ArchiveAiEmployeePayload

Description

Autogenerated return type of ArchiveAiEmployee.

Fields
Field Name Description
archivedEmployeeId - String
errors - [String!]!
Example
{
  "archivedEmployeeId": "xyz789",
  "errors": ["xyz789"]
}

ArchiveAiInboxItemPayload

Description

Autogenerated return type of ArchiveAiInboxItem.

Fields
Field Name Description
errors - [String!]!
itemId - String
Example
{
  "errors": ["xyz789"],
  "itemId": "abc123"
}

ArchiveAllAiInboxItemsPayload

Description

Autogenerated return type of ArchiveAllAiInboxItems.

Fields
Field Name Description
archivedCount - Int!
errors - [String!]!
Example
{"archivedCount": 123, "errors": ["xyz789"]}

ArchiveFeedbackTagPayload

Description

Autogenerated return type of ArchiveFeedbackTag.

Fields
Field Name Description
errors - [String!]!
feedbackTag - FeedbackTag
Example
{
  "errors": ["abc123"],
  "feedbackTag": FeedbackTag
}

ArchiveSubCommunityPayload

Description

Autogenerated return type of ArchiveSubCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
Example
{
  "community": Community,
  "errors": ["abc123"]
}

AutoCheckInDay

Description

One day of the weekly auto-check-in board (OBJ-6493 Task 2).

Fields
Field Name Description
date - ISO8601Date!
entries - [ProviderCount!]! Per-provider counts for this day, ordered by that provider's earliest check-in that day.
total - Int! Check-ins this day, across every provider.
Example
{
  "date": ISO8601Date,
  "entries": [ProviderCount],
  "total": 123
}

AutoCheckInWeek

Description

The current user's auto-check-in board for the Monday-start week in their own time zone (OBJ-6493 Task 2; UI-SPEC § Data contract).

Fields
Field Name Description
days - [AutoCheckInDay!]! Exactly 7 days, Monday through Sunday.
providerTotals - [ProviderCount!]! Only providers with a count above 0 this week, in provider-registry order.
today - ISO8601Date! The user's local date.
total - Int! Check-ins this week, across every provider.
weekStart - ISO8601Date! Monday of the user's current week.
Example
{
  "days": [AutoCheckInDay],
  "providerTotals": [ProviderCount],
  "today": ISO8601Date,
  "total": 123,
  "weekStart": ISO8601Date
}

BadgeSource

Description

Where a badge was earned, when a source was recorded for it.

Fields
Field Name Description
goal - BadgeSourceGoal The goal this badge is tied to. Null if there is none, the goal is soft-deleted, or the viewer cannot see it.
inferred - Boolean! True when this source was reconstructed by the one-time backfill, rather than recorded live when the badge was awarded.
kind - String! What earned the badge: habit_check_in, goal_event, mood_log, goal_completed, milestone_completed, milestone_created, or retroactive.
occurredAt - String ISO 8601 timestamp of the action that earned the badge.
recordId - ID Public id of the check-in, event, or milestone that earned the badge, when known.
Example
{
  "goal": BadgeSourceGoal,
  "inferred": false,
  "kind": "abc123",
  "occurredAt": "abc123",
  "recordId": "4"
}

BadgeSourceCommunity

Description

The community a founding_member badge was earned in, when the viewer can see it.

Fields
Field Name Description
id - ID! Public identifier for the community.
name - String! The community's current display name.
Example
{"id": 4, "name": "abc123"}

BadgeSourceGoal

Description

The goal a badge was earned on, when the viewer is allowed to see it.

Fields
Field Name Description
id - ID! Public identifier for the goal.
name - String! Display name of the goal.
Example
{"id": 4, "name": "xyz789"}

BadgeStat

Description

Unlock statistics for a single badge

Fields
Field Name Description
badgeKey - String! The badge key (action name)
percentage - Float! Percentage of users who have unlocked this badge (0-100)
Example
{"badgeKey": "abc123", "percentage": 123.45}

BeginImportPayload

Description

Autogenerated return type of BeginImport.

Fields
Field Name Description
dataImport - DataImport
errors - [String!]!
Example
{
  "dataImport": DataImport,
  "errors": ["abc123"]
}

BlockAllyPayload

Description

Autogenerated return type of BlockAlly.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": true}

Boolean

Description

The Boolean scalar type represents true or false.

BulkReviewContentFlagsPayload

Description

Autogenerated return type of BulkReviewContentFlags.

Fields
Field Name Description
errors - [String!]!
reviewedCount - Int!
Example
{"errors": ["abc123"], "reviewedCount": 987}

CancelAllyRequestPayload

Description

Autogenerated return type of CancelAllyRequest.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": false}

CancelCommunityEventPayload

Description

Autogenerated return type of CancelCommunityEvent.

Fields
Field Name Description
communityEvent - CommunityEvent
errorCode - String Stable machine code for the failure (N1), e.g. event_cancelled.
errors - [String!]!
Example
{
  "communityEvent": CommunityEvent,
  "errorCode": "abc123",
  "errors": ["xyz789"]
}

CancelHeadCoachTurnPayload

Description

Autogenerated return type of CancelHeadCoachTurn.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["abc123"], "success": false}

CancelPactPayload

Description

Autogenerated return type of CancelPact.

Fields
Field Name Description
errors - [String!]!
pact - Pact
Example
{
  "errors": ["abc123"],
  "pact": Pact
}

CancelPartnerRequestPayload

Description

Autogenerated return type of CancelPartnerRequest.

Fields
Field Name Description
errors - [String!]!
userAlly - UserAlly
Example
{
  "errors": ["abc123"],
  "userAlly": UserAlly
}

CancelSupporterSubscriptionPayload

Description

Autogenerated return type of CancelSupporterSubscription.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": true}

CancelTeamSubscriptionPayload

Description

Autogenerated return type of CancelTeamSubscription.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["abc123"], "success": true}

CascadeCounts

Fields
Field Name Description
adminActions - Int!
aiEmployeeMemories - Int!
communityComments - Int!
communityMemberships - Int!
communityPosts - Int!
encouragements - Int!
goalEvents - Int!
goals - Int!
milestones - Int!
moodLogs - Int!
user - Int!
userActions - Int!
userDevices - Int!
Example
{
  "adminActions": 123,
  "aiEmployeeMemories": 123,
  "communityComments": 123,
  "communityMemberships": 987,
  "communityPosts": 987,
  "encouragements": 987,
  "goalEvents": 987,
  "goals": 987,
  "milestones": 987,
  "moodLogs": 123,
  "user": 987,
  "userActions": 987,
  "userDevices": 123
}

CascadePreview

Fields
Field Name Description
counts - CascadeCounts!
totalModels - Int!
totalRecords - Int!
Example
{
  "counts": CascadeCounts,
  "totalModels": 123,
  "totalRecords": 123
}

CategoryStats

Description

Statistics for goal categories

Fields
Field Name Description
count - Int!
name - String!
Example
{"count": 123, "name": "xyz789"}

CelebrationConfettiEnum

Description

How much confetti an encouragement celebration shows.

Values
Enum Value Description

LOTS

A big burst.

STANDARD

The default burst.

SUBTLE

A light burst.
Example
"LOTS"

CelebrationPreferences

Description

How the encouragement celebration plays for the user (v4.107 D8).

Fields
Field Name Description
autoClose - Boolean! Whether the celebration closes itself after its countdown.
confetti - CelebrationConfettiEnum! How much confetti the celebration shows.
reducedMotion - CelebrationReducedMotionEnum! Whether the celebration reduces its motion.
Example
{"autoClose": true, "confetti": "LOTS", "reducedMotion": "OFF"}

CelebrationReducedMotionEnum

Description

Whether an encouragement celebration plays its motion.

Values
Enum Value Description

OFF

Always play the full motion.

ON

Always reduce motion.

SYSTEM

Follow the device reduced-motion setting.
Example
"OFF"

ChallengeParticipant

Description

A single user participation record within a community challenge, tracking progress toward completion.

Fields
Field Name Description
communityChallenge - CommunityChallenge The challenge this participation belongs to.
completed - Boolean! Whether the participant has met the completion threshold.
completedAt - ISO8601DateTime When the target was crossed. Nil if not yet complete.
progressCount - Int! Number of qualifying goal events logged so far.
progressPercent - Float! Progress toward completion as a percentage (0–100), clamped.
publicId - ID! URL-safe public identifier for this participation record.
rank - Int Leaderboard rank (1-indexed). Set by the leaderboard resolver; nil outside that context.
user - User The participating user.
userPublicId - String Public ID of the participating user (safe for membership checks).
Example
{
  "communityChallenge": CommunityChallenge,
  "completed": true,
  "completedAt": ISO8601DateTime,
  "progressCount": 987,
  "progressPercent": 987.65,
  "publicId": "4",
  "rank": 123,
  "user": User,
  "userPublicId": "xyz789"
}

ChannelAverage

Fields
Field Name Description
channel - String!
clicks - Float
engagementRate - Float
impressions - Float
Example
{
  "channel": "abc123",
  "clicks": 987.65,
  "engagementRate": 987.65,
  "impressions": 123.45
}

CheckInHabitPayload

Description

Autogenerated return type of CheckInHabit.

Fields
Field Name Description
checkinToken - String Rotated check-in token, present only when this request was authenticated by a check-in token. A rejected rotation (nil) is native's signal to fall back to the foreground drain.
dayClosedToday - Boolean User.dayClosedToday (E7), recomputed after this check-in. Null on failure.
errors - [String!]!
goal - Goal
habitCompletion - HabitCompletion The check-in that was recorded (or the existing one on a replay).
xpAwarded - Int Total XP this check-in awarded (OBJ-6062, mirrors AddGoalEvent OBJ-5989). 0 on a replay/duplicate; null on failure.
Example
{
  "checkinToken": "abc123",
  "dayClosedToday": true,
  "errors": ["xyz789"],
  "goal": Goal,
  "habitCompletion": HabitCompletion,
  "xpAwarded": 123
}

CheckValidUsernamePayload

Description

Autogenerated return type of CheckValidUsername.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

ClaimAiArtifactPayload

Description

Autogenerated return type of ClaimAiArtifact.

Fields
Field Name Description
artifact - AiArtifact
errors - [String!]!
Example
{
  "artifact": AiArtifact,
  "errors": ["xyz789"]
}

ClaimStreakInsurancePayload

Description

Autogenerated return type of ClaimStreakInsurance.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

CoachAction

Description

A tappable action chip suggested by the Coach alongside its reply.

Fields
Field Name Description
kind - String! Action discriminator: log_event | log_mood | view_goal | create_milestone | open_meet_coach | suggest_practice | open_route.
label - String! Human-readable button label (e.g. "Log progress on Run a 5K").
targetId - String public_id of the target record (e.g. goal public_id for log_event), or the allow-listed route key for open_route (the client owns its label and path). Null for actions with no specific target.
Example
{
  "kind": "abc123",
  "label": "abc123",
  "targetId": "abc123"
}

CoachConversation

Description

A persisted conversation thread between a user and their Coach.

Fields
Field Name Description
goalId - String public_id of the goal this thread is scoped to, or null for the global thread.
id - String! public_id of this conversation.
lastMessageAt - ISO8601DateTime Timestamp of the last message.
messages - [CoachMessage!]! Messages in this thread, oldest first. With coach_single_conversation_enabled on, this is the union of every live conversation the owner has (v4.127 D10).
Example
{
  "goalId": "abc123",
  "id": "abc123",
  "lastMessageAt": ISO8601DateTime,
  "messages": [CoachMessage]
}

CoachGoalSuggestionsPreferences

Description

"Let Coach suggest goal changes" preference for the authenticated user (v4.102 D16).

Fields
Field Name Description
enabled - Boolean! Whether Coach may suggest goal changes in chat. Defaults to true.
Example
{"enabled": false}

CoachMessage

Description

A single message in a Coach conversation thread.

Fields
Field Name Description
content - String! Message text.
context - CoachMessageContext Where this message was sent from: page and/or goal (v4.127). Null when the message carries no context tag.
createdAt - ISO8601DateTime! When this message was sent.
guideCitations - [GuideCitation!]! Validated guide citations for this reply, resolved for read_guide chips (v4.106).
id - String! public_id of this message.
proposal - CoachProposal The change Coach proposed alongside this reply, if any (v4.102 goal actions).
role - String! Who sent the message: "user" or "assistant".
Example
{
  "content": "abc123",
  "context": CoachMessageContext,
  "createdAt": ISO8601DateTime,
  "guideCitations": [GuideCitation],
  "id": "abc123",
  "proposal": CoachProposal,
  "role": "xyz789"
}

CoachMessageContext

Description

Per-message context tag: the page and/or goal Coach was viewing when this message was sent (v4.127).

Fields
Field Name Description
goalId - String public_id of the goal this message's context refers to, or null.
goalRemoved - Boolean! True when goalId names a goal that no longer exists (soft-deleted or not found).
goalTitle - String Name of the goal, resolved for display; null when goalId is null or goalRemoved is true.
page - String Allow-listed CoachPage value, or null when the message carries no page context.
Example
{
  "goalId": "xyz789",
  "goalRemoved": false,
  "goalTitle": "xyz789",
  "page": "xyz789"
}

CoachModelChange

Description

One entry in the Coach model change history, sourced from admin_actions.

Fields
Field Name Description
actorName - String The admin's full name, or null if unavailable.
changedAt - ISO8601DateTime! When the change was made.
fromModel - String Prior model id — null for the very first change.
toModel - String! Model id the setting was changed to.
Example
{
  "actorName": "abc123",
  "changedAt": ISO8601DateTime,
  "fromModel": "xyz789",
  "toModel": "abc123"
}

CoachModelOption

Description

An allowlisted Gemini model id Coach may run, with its current effective rate.

Fields
Field Name Description
id - String! Concrete model id (e.g. gemini/gemini-2.5-flash).
inputCentsPerMillion - Int! Current input rate, cents per million tokens.
label - String! Human-readable name derived from the model id.
outputCentsPerMillion - Int! Current output rate, cents per million tokens.
Example
{
  "id": "abc123",
  "inputCentsPerMillion": 987,
  "label": "abc123",
  "outputCentsPerMillion": 123
}

CoachModelSetting

Description

The runtime Coach Gemini model setting: current value, allowlisted options, and recent change history.

Fields
Field Name Description
currentModel - String! The model id Coach is currently running.
options - [CoachModelOption!]! Allowlisted model ids with their current effective rates.
recentChanges - [CoachModelChange!]! Last 5 changes to the setting, newest first.
Example
{
  "currentModel": "abc123",
  "options": [CoachModelOption],
  "recentChanges": [CoachModelChange]
}

CoachProposal

Description

A change Coach proposed for the user to approve. Nothing is written to their goals until they Apply it. A goal that changed since Coach staged the proposal shows up after Apply as FAILED with errorCode "stale".

Fields
Field Name Description
consequence - String Streak line (e.g. "Your 23-day streak stays."); only while the proposal is pending.
errorCode - String Why an apply failed (e.g. "stale"), so a reloaded Failed card can pick its copy.
errorMessage - String Canned user-facing copy for errorCode; may be more generic than the error Apply returned. Null when there is no errorCode.
expiresAt - ISO8601DateTime When a pending proposal goes out of date; null never expires.
id - String! public_id of this proposal.
status - CoachProposalStatusEnum! Current state; a PROPOSED row past its expiry reads EXPIRED.
steps - [CoachProposalStep!]! One display row per step, as a before-to-after diff.
undoUntil - ISO8601DateTime End of the undo window once applied.
Example
{
  "consequence": "xyz789",
  "errorCode": "abc123",
  "errorMessage": "xyz789",
  "expiresAt": ISO8601DateTime,
  "id": "abc123",
  "status": "APPLIED",
  "steps": [CoachProposalStep],
  "undoUntil": ISO8601DateTime
}

CoachProposalChange

Description

One before-to-after field change inside a Coach proposal step.

Fields
Field Name Description
after - String The value the proposal sets.
before - String The goal's live value; only filled while the proposal is pending, and null for a new practice.
field - String! Client-facing field name: name, description, targetDate, shape, cadence, weeklyTarget, linkedGoal.
Example
{
  "after": "xyz789",
  "before": "abc123",
  "field": "xyz789"
}

CoachProposalDismissReasonEnum

Description

Why a Coach proposal is being closed without Apply.

Values
Enum Value Description

APPLIED_VIA_FORM

The user took Edit and saved the normal goal form.

DISMISSED

The user chose Not now.
Example
"APPLIED_VIA_FORM"

CoachProposalStatusEnum

Description

Where a Coach proposal stands. EXPIRED is also reported for a PROPOSED row past its expiry (no job sweeps rows; Apply or Dismiss marks one expired when it touches it).

Values
Enum Value Description

APPLIED

Applied; undoable until undoUntil.

APPLIED_VIA_FORM

The user took Edit and saved the normal goal form instead.

DISMISSED

The user chose Not now.

EXPIRED

Past its expiry (also reported for a PROPOSED row past expiresAt).

FAILED

Apply failed; nothing was changed. See errorCode ("stale" when a goal changed since staging).

PROPOSED

Waiting for the user to apply, edit or dismiss it.

UNDONE

Applied, then undone inside the undo window.
Example
"APPLIED"

CoachProposalStep

Description

One display row of a Coach proposal: what it does to which goal.

Fields
Field Name Description
changes - [CoachProposalChange!]! Field changes (UPDATE_GOAL, and the cadence of ADD_PRACTICE).
goalId - String public_id of the goal this step targets (the habit, for LINK_PRACTICE and UNLINK_PRACTICE). For CREATE_GOAL it is null until the proposal is applied, then the new goal.
goalName - String The target goal's current name (the new goal's name for CREATE_GOAL); null when the goal no longer exists.
items - [String!]! Milestone names (ADD_MILESTONES, CREATE_GOAL) or the practice name (ADD_PRACTICE); empty otherwise.
kind - CoachProposalStepKindEnum!
optional - Boolean! True for the one extra step the user may untick (applyCoachProposal skipOptional).
Example
{
  "changes": [CoachProposalChange],
  "goalId": "abc123",
  "goalName": "xyz789",
  "items": ["abc123"],
  "kind": "ADD_MILESTONES",
  "optional": true
}

CoachProposalStepKindEnum

Description

What one step of a Coach proposal does to a goal.

Values
Enum Value Description

ADD_MILESTONES

Append milestones to the goal.

ADD_PRACTICE

Add a new habit as a practice for the goal.

CREATE_GOAL

Create a new goal or habit.

LINK_PRACTICE

Link an existing habit as the practice of a goal; the habit keeps its streak.

UNLINK_PRACTICE

Unlink a habit from the goal it is the practice of; both stay.

UPDATE_GOAL

Edit the goal or habit (name, description, target date, shape, cadence).
Example
"ADD_MILESTONES"

CoachingPreferences

Description

AI Coach persona and communication preferences for the user.

Fields
Field Name Description
configured - Boolean! Whether the user has completed coach setup.
depth - Int! Response depth from 1 (brief) to 5 (detailed).
focusPrimary - String! Primary coaching focus area.
focusSecondary - String Optional secondary coaching focus area.
persona - String! Selected coaching persona identifier.
rhythm - String! How often Coach reaches out proactively.
toneBrevity - Int! Tone brevity from 0 to 4. Folded into depth (v4.83); ignored by the Coach.
toneWarmth - Int! Tone warmth from 0 to 4.
Example
{
  "configured": false,
  "depth": 987,
  "focusPrimary": "abc123",
  "focusSecondary": "xyz789",
  "persona": "abc123",
  "rhythm": "xyz789",
  "toneBrevity": 123,
  "toneWarmth": 123
}

CollectiveGoal

Description

A collective (team-wide or sub-community) goal (N15/N16).

Fields
Field Name Description
contributors - [CollectiveGoalContributor!]!
createdBy - String!
current - Int!
daysLeft - Int Null when no deadline is set (no CreateCollectiveGoal argument sets one this phase) — never a fabricated 0.
publicId - ID!
scope - String!
target - Int!
targetMetric - String! One of CollectiveGoal::TARGET_METRICS (check_ins, milestones_completed, members_active_days, custom).
title - String!
yourContribution - CollectiveGoalYourContribution
Example
{
  "contributors": [CollectiveGoalContributor],
  "createdBy": "xyz789",
  "current": 123,
  "daysLeft": 123,
  "publicId": "4",
  "scope": "xyz789",
  "target": 987,
  "targetMetric": "abc123",
  "title": "abc123",
  "yourContribution": CollectiveGoalYourContribution
}

CollectiveGoalContributor

Description

A contributor slice on a collective goal (N16).

Fields
Field Name Description
anonymous - Boolean
color - String
count - Int!
id - ID!
name - String!
Example
{
  "anonymous": false,
  "color": "abc123",
  "count": 987,
  "id": 4,
  "name": "xyz789"
}

CollectiveGoalYourContribution

Description

The viewer's own contribution to a collective goal (N16).

Fields
Field Name Description
count - Int!
sourceGoal - String!
Example
{"count": 123, "sourceGoal": "xyz789"}

CommitImportPayload

Description

Autogenerated return type of CommitImport.

Fields
Field Name Description
dataImport - DataImport
errors - [String!]!
Example
{
  "dataImport": DataImport,
  "errors": ["xyz789"]
}

Community

Description

An interest-based group where users share goals and support each other.

Fields
Field Name Description
activeChallenge - CommunityChallenge The currently active challenge for this community, or nil.
activeMembers - Int! Count of members who posted or commented in the past 7 days.
archiveDaysLeft - Int Days remaining in the 30-day archive read-only window, or nil when not archived.
archivedAt - ISO8601DateTime When this Team sub-community began its archive window, or nil.
badges - CommunityBadges! Threshold and status marks describing this community.
category - String General category label for the community (e.g. "fitness").
checkInsPerWeek - Int! Check-ins logged by members in the trailing 7 days. Always 0 in Phase 3 — no check-in tracking model exists yet for sub-communities.
coverImage - String URL of the community banner/cover image.
createdAt - ISO8601DateTime! ISO 8601 datetime when the community was created.
createdAtTime - String! Unix timestamp (string) when the community was created.
demo - Boolean! Whether this community is a demo-tagged record (Phase 30).
description - String Human-readable description of the community purpose.
editorialPosition - Int Display order within editorial_slot, or nil when unassigned.
editorialSlot - String Editorial discovery slot this community is assigned to, or nil when unassigned.
feedItems - [CommunityFeedItem!] Recent activity feed items for this community.
goalCategory - GoalCategory The primary goal category this community is focused on.
goals - [Goal!] Goals that have been shared into this community.
growthRate - Float! Member growth rate as a percentage over the past 7 days.
guidelines - String Community rules and posting guidelines.
healthScore - Int! Computed health score (0–100) reflecting community engagement.
icon - String! Display icon key for a Team sub-community (sunrise/book/leaf/mountain/users).
id - ID! Alias of publicId (BaseObject#id) — the Teams frontend list types key on both.
imageUrl - String URL of the community avatar/icon image.
isDefault - Boolean! Alias of isDefaultForTeam — the Teams frontend (types.ts TeamRoom.isDefault, and every sub-community mutation/query response) is frozen on this shorter name.
isDefaultForTeam - Boolean! Whether this is the Team's default landing room.
isFeatured - Boolean! Whether the community is featured on the discovery page.
isFounding - Boolean! True when the community became discoverable within 30 days of its creation.
isGated - Boolean! True when join_policy is "request" — joining requires the lead to approve.
isMember - Boolean! Whether the current user is a member of this community.
isVerified - Boolean! Always false — community verification was retired (OBJ-3197). Community verification was retired (OBJ-3197); always false.
joinPolicy - String! Join policy for a Team sub-community: "open" or "request".
leadMembershipId - ID Public ID of the sub-community lead's TeamMembership on this team, or nil when the lead has since left the team.
leadName - String The sub-community's lead (its admin-role CommunityMember) first name, or nil.
memberCount - Int! Total number of members in this community.
members - [CommunityMember!] All current members of this community.
membersToDiscoverable - Int! Members still needed to appear in discovery (0 when discoverable).
name - String! Display name of the community.
pastChallenges - [CommunityChallenge!] Completed challenges for this community.
privacy - String! Privacy level string: "public" or "private".
private - Boolean! When true, membership requires an invite or approval.
publicId - ID! URL-safe public identifier for this community.
reason - CommunityReason Disclosable reason this community is ranked here, or null.
teamId - ID Public ID of the owning Team, when this community is a Team sub-community.
teamName - String Display name of the owning Team, when this community is a Team sub-community, or nil.
totalGoals - Int! Total number of goals shared in this community.
upcomingChallenges - [CommunityChallenge!] Upcoming challenges for this community.
upcomingEvents - [CommunityEvent!] Up to 10 upcoming approved events for this community. Visible to members and to anyone who can see a public community; empty for a non-member of a private or Team room.
updatedAtTime - String! Unix timestamp (string) when the community was last updated.
userProgressPercent - Float Per-user aggregate progress (0–100) across shared goals. Null when no shared goals.
viewerCanCreateEvents - Boolean! Whether the current viewer can create a meetup in this community (a site admin, or a community admin/moderator) (D1, N2).
viewerDigest - CommunityViewerDigest Quiet "what's new" summary. Null unless the viewer has joined this community. Batch-loaded across joined communities.
Example
{
  "activeChallenge": CommunityChallenge,
  "activeMembers": 123,
  "archiveDaysLeft": 123,
  "archivedAt": ISO8601DateTime,
  "badges": CommunityBadges,
  "category": "xyz789",
  "checkInsPerWeek": 123,
  "coverImage": "abc123",
  "createdAt": ISO8601DateTime,
  "createdAtTime": "abc123",
  "demo": true,
  "description": "xyz789",
  "editorialPosition": 987,
  "editorialSlot": "xyz789",
  "feedItems": [CommunityFeedItem],
  "goalCategory": GoalCategory,
  "goals": [Goal],
  "growthRate": 987.65,
  "guidelines": "xyz789",
  "healthScore": 123,
  "icon": "xyz789",
  "id": "4",
  "imageUrl": "xyz789",
  "isDefault": false,
  "isDefaultForTeam": false,
  "isFeatured": true,
  "isFounding": false,
  "isGated": true,
  "isMember": true,
  "isVerified": false,
  "joinPolicy": "abc123",
  "leadMembershipId": 4,
  "leadName": "xyz789",
  "memberCount": 123,
  "members": [CommunityMember],
  "membersToDiscoverable": 123,
  "name": "abc123",
  "pastChallenges": [CommunityChallenge],
  "privacy": "xyz789",
  "private": false,
  "publicId": "4",
  "reason": CommunityReason,
  "teamId": 4,
  "teamName": "xyz789",
  "totalGoals": 987,
  "upcomingChallenges": [CommunityChallenge],
  "upcomingEvents": [CommunityEvent],
  "updatedAtTime": "abc123",
  "userProgressPercent": 987.65,
  "viewerCanCreateEvents": false,
  "viewerDigest": CommunityViewerDigest
}

CommunityBadges

Description

Threshold and status marks describing a community. Each field states its own threshold — see field descriptions.

Fields
Field Name Description
club1k - Boolean! 1,000 or more people are currently members of this community.
featured - Boolean! An Objectuve admin has marked this community as featured. Does not affect discovery ranking.
streak100 - Boolean! 10 or more current members have each reached a streak of 100 days or longer at some point. Derived from users.longest_streak, which is monotonic — never from current_streak, which goes stale.
wins500 - Boolean! Members of this community have completed 500 or more goals, all-time.
Example
{"club1k": true, "featured": false, "streak100": false, "wins500": true}

CommunityChallenge

Description

A time-boxed challenge within a community where participants track progress toward a shared goal.

Fields
Field Name Description
badgeIcon - String! Emoji or icon string for the completion badge.
badgeName - String! Name of the badge awarded to challenge completers.
community - Community! The community this challenge belongs to.
createdAtTime - String! Unix timestamp (string) when the challenge was created.
creator - User! The user who created the challenge.
currentUserParticipant - ChallengeParticipant The current user's participation row, or nil.
description - String Optional description of the challenge.
endDate - ISO8601Date! Date when the challenge ends (inclusive).
isParticipating - Boolean! Whether the current user is an active participant.
name - String! Display name of the challenge.
participantCount - Int! Total number of active participants in the challenge.
publicId - ID! URL-safe public identifier for this challenge.
startDate - ISO8601Date! Date when the challenge begins.
status - String! Date-derived status: "upcoming", "active", or "completed".
targetGoalCount - Int! Number of qualifying goal events required to complete the challenge.
targetGoalType - GoalType Optional goal type filter. Nil means any goal event counts.
updatedAtTime - String! Unix timestamp (string) when the challenge was last updated.
Example
{
  "badgeIcon": "xyz789",
  "badgeName": "abc123",
  "community": Community,
  "createdAtTime": "abc123",
  "creator": User,
  "currentUserParticipant": ChallengeParticipant,
  "description": "abc123",
  "endDate": ISO8601Date,
  "isParticipating": false,
  "name": "xyz789",
  "participantCount": 123,
  "publicId": "4",
  "startDate": ISO8601Date,
  "status": "xyz789",
  "targetGoalCount": 123,
  "targetGoalType": GoalType,
  "updatedAtTime": "abc123"
}

CommunityEvent

Description

A scheduled event or activity within a community.

Fields
Field Name Description
attendeeCount - Int! Number of community members who have indicated they will attend.
communityId - ID! public_id of the community hosting this event.
communityName - String! Name of the community hosting this event.
date - String! Unix timestamp (string) of when the event takes place.
description - String Optional longer description of what the event involves.
endsAt - ISO8601DateTime ISO 8601 datetime of when the event ends, or nil when not set.
id - ID! Public identifier for this event.
location - String Where the event takes place, or nil when not set.
startsAt - ISO8601DateTime! ISO 8601 datetime of when the event starts.
title - String! Title of the community event.
viewerCanManage - Boolean! Whether the current viewer can edit or moderate this event (the creator, a community admin or moderator, or a site admin).
viewerIsGoing - Boolean! Whether the current viewer has RSVPed to attend this event.
Example
{
  "attendeeCount": 123,
  "communityId": 4,
  "communityName": "xyz789",
  "date": "xyz789",
  "description": "abc123",
  "endsAt": ISO8601DateTime,
  "id": 4,
  "location": "abc123",
  "startsAt": ISO8601DateTime,
  "title": "abc123",
  "viewerCanManage": true,
  "viewerIsGoing": false
}

CommunityEventFlagDetails

Description

Event details for a CommunityEvent content flag.

Fields
Field Name Description
communityName - String
creatorName - String
description - String
endsAt - ISO8601DateTime
isCancelled - Boolean!
location - String
startsAt - ISO8601DateTime!
title - String!
Example
{
  "communityName": "abc123",
  "creatorName": "xyz789",
  "description": "abc123",
  "endsAt": ISO8601DateTime,
  "isCancelled": false,
  "location": "xyz789",
  "startsAt": ISO8601DateTime,
  "title": "xyz789"
}

CommunityFeedItem

Description

A single item in a community activity feed (e.g. a goal update or milestone).

Fields
Field Name Description
content - String! Text content of the feed item.
createdAtTime - String! Unix timestamp (string) when this item was created.
id - ID! Public identifier for this feed item.
media - CommunityMedia Optional media attachment for this feed item.
updatedAtTime - String! Unix timestamp (string) when this item was last updated.
Example
{
  "content": "xyz789",
  "createdAtTime": "abc123",
  "id": "4",
  "media": CommunityMedia,
  "updatedAtTime": "xyz789"
}

CommunityGoal

Description

A goal that has been shared into a community, linking the goal to the community feed.

Fields
Field Name Description
community - Community The community the goal was shared into.
createdAtTime - String! Unix timestamp (string) when the goal was shared into the community.
goal - Goal The goal that was shared.
id - ID! Public identifier for this community-goal association.
updatedAtTime - String! Unix timestamp (string) when the association was last updated.
Example
{
  "community": Community,
  "createdAtTime": "abc123",
  "goal": Goal,
  "id": 4,
  "updatedAtTime": "xyz789"
}

CommunityInsights

Description

Community engagement insights and recommendations for a specific user.

Fields
Field Name Description
achievementsUnlocked - Int! Number of community-related achievements unlocked by the user.
communitiesJoined - Int! Total number of communities the user has joined.
hasGoalSignal - Boolean! True when the user has at least one goal with a goal category set — the signal the Explore subhead (UI-SPEC v4.63 Phase 4 §4) keys its S1/S2/S3 states on.
partnersCount - Int! Count of accepted accountability partners for the user.
postsThisWeek - Int! Number of posts the user has made in communities this week.
suggestedCommunities - [SuggestedCommunity!]! Communities recommended for the user to join based on their interests.
suggestedCount - Int! Number of communities suggested for the user to join.
totalEngagement - Int! Aggregate engagement score across all communities.
trendingCommunities - [TrendingCommunity!]! Currently trending communities across the platform.
upcomingEvents - [CommunityEvent!]! Upcoming events in communities the user belongs to, within the next 30 days, capped at 3.
yourActivity - [UserActivity!]! Recent activity items for the user across their communities.
Example
{
  "achievementsUnlocked": 123,
  "communitiesJoined": 987,
  "hasGoalSignal": true,
  "partnersCount": 987,
  "postsThisWeek": 987,
  "suggestedCommunities": [SuggestedCommunity],
  "suggestedCount": 987,
  "totalEngagement": 987,
  "trendingCommunities": [TrendingCommunity],
  "upcomingEvents": [CommunityEvent],
  "yourActivity": [UserActivity]
}

CommunityMedia

Description

A media attachment (image) associated with a community feed item or post.

Fields
Field Name Description
id - ID! Public identifier for this media record.
imageUrl - String URL of the image.
name - String Optional descriptive name or caption for the image.
Example
{
  "id": 4,
  "imageUrl": "xyz789",
  "name": "xyz789"
}

CommunityMember

Description

A user membership record within a community, with engagement statistics.

Fields
Field Name Description
createdAtTime - String! Unix timestamp (string) when the user joined the community.
goalsCompleted - Int! Number of goals completed by this user (proxy for community contribution).
helpfulCount - Int! Count of helpful reactions received by this user in the community.
id - ID! Public identifier for this membership record.
joinedDate - String! Unix timestamp (string) alias for created_at_time.
points - Int! Engagement points accumulated by this member in the community.
postsCount - Int! Number of posts this user has made in this community.
rank - Int Leaderboard rank of this member within the community.
role - String! Role within the community (e.g. "member", "moderator", "admin").
updatedAtTime - String! Unix timestamp (string) when the membership record was last updated.
user - User The user who is a member of the community.
userPublicId - String Public ID of the member user (safe for membership checks).
Example
{
  "createdAtTime": "abc123",
  "goalsCompleted": 123,
  "helpfulCount": 987,
  "id": 4,
  "joinedDate": "xyz789",
  "points": 987,
  "postsCount": 987,
  "rank": 123,
  "role": "xyz789",
  "updatedAtTime": "xyz789",
  "user": User,
  "userPublicId": "abc123"
}

CommunityPost

Description

A discussion post or update made by a user within a community.

Fields
Field Name Description
comments - [PostComment!]! Comments left on this post.
communityId - ID! public_id of the community this post belongs to.
content - String! Body text of the post.
goalId - ID public_id of the goal linked to this post, if any.
goalName - String Name of the linked goal, if any.
id - ID! Public identifier for this post.
likes - Int! Number of like reactions on this post.
timestamp - String! Unix timestamp (string) when the post was created.
type - String! Post type (discussion, achievement, or milestone).
userId - ID! public_id of the user who created the post.
userName - String! Username of the post author.
userPhoto - String Profile photo URL of the post author.
Example
{
  "comments": [PostComment],
  "communityId": "4",
  "content": "abc123",
  "goalId": 4,
  "goalName": "xyz789",
  "id": 4,
  "likes": 123,
  "timestamp": "abc123",
  "type": "abc123",
  "userId": "4",
  "userName": "abc123",
  "userPhoto": "xyz789"
}

CommunityReason

Description

The single reason a discovery surface is allowed to show this community, chosen by fixed precedence (goal_category -> seasonal_event -> community_health), never by score. The backend never returns kind: "ally_overlap" — ally overlap ranks but is never disclosed (v4.63 Phase 4 §1).

Fields
Field Name Description
disclosable - Boolean! false for ally_overlap, true for every other kind. Belt-and-braces: the resolver already withholds ally_overlap reasons, but the flag lives on the reason so the frontend is never the thing that remembers which signals are safe to show.
kind - String! One of: goal_category, seasonal_event, community_health, ally_overlap. (ally_overlap is never actually returned by any resolver.)
label - String The interpolation value only, verbatim and un-re-cased — the goal category name or the SeasonalEvent display name. null for community_health. The frontend composes the chip sentence (UI-SPEC v4.63 Phase 4 §2); this field never carries pre-composed copy.
Example
{
  "disclosable": false,
  "kind": "abc123",
  "label": "xyz789"
}

CommunitySuggestion

Description

A user-submitted suggestion for a new community topic or interest area.

Fields
Field Name Description
content - String! Text of the community suggestion.
goalCategory - GoalCategory Goal category the suggested community would belong to, if specified.
goalKind - GoalType Goal type the suggested community would focus on, if specified.
id - ID! Public identifier for this suggestion.
Example
{
  "content": "xyz789",
  "goalCategory": GoalCategory,
  "goalKind": GoalType,
  "id": "4"
}

CommunityViewerDigest

Description

A quiet "what's new" line for a community the viewer has joined. Deliberately carries no unread count.

Fields
Field Name Description
latestActivityAt - ISO8601DateTime When the most recent approved post was made, or null.
latestActivitySummary - String Excerpt (up to 120 characters) of the most recent approved post, or null.
postsThisWeek - Int! Approved posts in the trailing 7 days, excluding blocked authors.
Example
{
  "latestActivityAt": ISO8601DateTime,
  "latestActivitySummary": "xyz789",
  "postsThisWeek": 987
}

CompleteOnboardingAndCreateGoalPayload

Description

Autogenerated return type of CompleteOnboardingAndCreateGoal.

Fields
Field Name Description
errors - [String!]!
goal - Goal
practice - Goal
user - User
Example
{
  "errors": ["xyz789"],
  "goal": Goal,
  "practice": Goal,
  "user": User
}

ConnectChessComPayload

Description

Autogenerated return type of ConnectChessCom.

Fields
Field Name Description
errors - [String!]!
integrationConnection - IntegrationConnection
Example
{
  "errors": ["xyz789"],
  "integrationConnection": IntegrationConnection
}

ConnectGithubPayload

Description

Autogenerated return type of ConnectGithub.

Fields
Field Name Description
authorizeUrl - String!
errors - [String!]!
Example
{
  "authorizeUrl": "xyz789",
  "errors": ["abc123"]
}

ConnectLichessPayload

Description

Autogenerated return type of ConnectLichess.

Fields
Field Name Description
errors - [String!]!
integrationConnection - IntegrationConnection
Example
{
  "errors": ["abc123"],
  "integrationConnection": IntegrationConnection
}

ConnectOuraPayload

Description

Autogenerated return type of ConnectOura.

Fields
Field Name Description
authorizeUrl - String
errors - [String!]!
Example
{
  "authorizeUrl": "abc123",
  "errors": ["xyz789"]
}

ConnectStravaPayload

Description

Autogenerated return type of ConnectStrava.

Fields
Field Name Description
authorizeUrl - String!
errors - [String!]!
Example
{
  "authorizeUrl": "abc123",
  "errors": ["xyz789"]
}

ConnectWithingsPayload

Description

Autogenerated return type of ConnectWithings.

Fields
Field Name Description
authorizeUrl - String!
errors - [String!]!
Example
{
  "authorizeUrl": "xyz789",
  "errors": ["xyz789"]
}

ConnectedApps

Description

The current user's Connected Apps state: the provider catalog plus their own connections and mappings.

Fields
Field Name Description
connections - [IntegrationConnection!]! The current user's connections.
habitLinkSummary - HabitLinkSummary Linked vs. linkable habit counts (OBJ-6493 D7). Null if the summary could not be built — the rest of this type still resolves.
mappings - [HabitIntegrationMapping!]! The current user's habit mappings.
providers - [IntegrationProvider!]! All available providers.
suggestions - [IntegrationSuggestion!] At most limit habit -> provider suggestions (OBJ-6493 D4-D6). Null if suggestions could not be built — the rest of this type still resolves.
Arguments
limit - Int
weeklyAutoCheckIns - AutoCheckInWeek The current user's auto-check-in board (OBJ-6493 Task 2). Null if it could not be built — the rest of this type still resolves.
Example
{
  "connections": [IntegrationConnection],
  "habitLinkSummary": HabitLinkSummary,
  "mappings": [HabitIntegrationMapping],
  "providers": [IntegrationProvider],
  "suggestions": [IntegrationSuggestion],
  "weeklyAutoCheckIns": AutoCheckInWeek
}

ContentFlag

Fields
Field Name Description
authorName - String
communityEventDetails - CommunityEventFlagDetails N4 (CommunityEvent only).
contentPreview - String First 200 characters of flagged content
createdAt - String!
flaggableId - Int!
flaggableType - String!
id - String! Public ID
reason - String
reviewedAt - String
reviewerName - String
severity - String!
source - String!
status - String!
Example
{
  "authorName": "abc123",
  "communityEventDetails": CommunityEventFlagDetails,
  "contentPreview": "xyz789",
  "createdAt": "xyz789",
  "flaggableId": 987,
  "flaggableType": "abc123",
  "id": "xyz789",
  "reason": "abc123",
  "reviewedAt": "abc123",
  "reviewerName": "abc123",
  "severity": "xyz789",
  "source": "abc123",
  "status": "xyz789"
}

ContentFlagConnection

Description

The connection type for ContentFlag.

Fields
Field Name Description
edges - [ContentFlagEdge] A list of edges.
nodes - [ContentFlag] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [ContentFlagEdge],
  "nodes": [ContentFlag],
  "pageInfo": PageInfo
}

ContentFlagEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - ContentFlag The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": ContentFlag
}

ContentReport

Fields
Field Name Description
contentPreview - String
createdAt - String!
details - String
id - String! Public ID
reason - String!
reportableType - String!
reporterName - String
status - String!
Example
{
  "contentPreview": "xyz789",
  "createdAt": "xyz789",
  "details": "abc123",
  "id": "abc123",
  "reason": "xyz789",
  "reportableType": "xyz789",
  "reporterName": "abc123",
  "status": "abc123"
}

ContinueGoalPayload

Description

Autogenerated return type of ContinueGoal.

Fields
Field Name Description
errorCode - String Stable machine code for the failure: the failing interaction's snake_case code (e.g. not_found, taken). Null on success. An open set, so treat an unknown code like any other failure.
errors - [String!]!
goal - Goal The newly created successor goal, on success.
Example
{
  "errorCode": "abc123",
  "errors": ["abc123"],
  "goal": Goal
}

ControlHeadCoachBulkRunPayload

Description

Autogenerated return type of ControlHeadCoachBulkRun.

Fields
Field Name Description
errors - [String!]!
run - HeadCoachBulkRun
success - Boolean!
Example
{
  "errors": ["xyz789"],
  "run": HeadCoachBulkRun,
  "success": false
}

CreateAiAssignmentFromChatPayload

Description

Autogenerated return type of CreateAiAssignmentFromChat.

Fields
Field Name Description
assignment - AiAssignment
errors - [String!]!
Example
{
  "assignment": AiAssignment,
  "errors": ["abc123"]
}

CreateAiAssignmentPayload

Description

Autogenerated return type of CreateAiAssignment.

Fields
Field Name Description
assignment - AiAssignment
errors - [String!]!
run - AiRun
Example
{
  "assignment": AiAssignment,
  "errors": ["abc123"],
  "run": AiRun
}

CreateAiAutopilotPayload

Description

Autogenerated return type of CreateAiAutopilot.

Fields
Field Name Description
autopilot - AiAutopilot
errors - [String!]!
Example
{
  "autopilot": AiAutopilot,
  "errors": ["abc123"]
}

CreateAiEmployeePayload

Description

Autogenerated return type of CreateAiEmployee.

Fields
Field Name Description
employee - AiEmployee
errors - [String!]!
Example
{
  "employee": AiEmployee,
  "errors": ["xyz789"]
}

CreateAiTaskPayload

Description

Autogenerated return type of CreateAiTask.

Fields
Field Name Description
errors - [String!]!
run - AiRun
Example
{
  "errors": ["abc123"],
  "run": AiRun
}

CreateAllyInvitePayload

Description

Autogenerated return type of CreateAllyInvite.

Fields
Field Name Description
errors - [String!]!
invite - AllyInvite
Example
{
  "errors": ["abc123"],
  "invite": AllyInvite
}

CreateCheckoutSessionPayload

Description

Autogenerated return type of CreateCheckoutSession.

Fields
Field Name Description
checkoutUrl - String
errors - [String!]!
Example
{
  "checkoutUrl": "abc123",
  "errors": ["xyz789"]
}

CreateCollectiveGoalPayload

Description

Autogenerated return type of CreateCollectiveGoal.

Fields
Field Name Description
collectiveGoal - CollectiveGoal
errors - [String!]!
teamReadOnly - Boolean! True only for the grace-period read-only failure — the frontend renders its own "team is read-only" copy for this.
Example
{
  "collectiveGoal": CollectiveGoal,
  "errors": ["xyz789"],
  "teamReadOnly": false
}

CreateCommunityChallengePayload

Description

Autogenerated return type of CreateCommunityChallenge.

Fields
Field Name Description
communityChallenge - CommunityChallenge
errors - [String!]!
Example
{
  "communityChallenge": CommunityChallenge,
  "errors": ["abc123"]
}

CreateCommunityEventPayload

Description

Autogenerated return type of CreateCommunityEvent.

Fields
Field Name Description
communityEvent - CommunityEvent
errorCode - String Stable machine code for the failure (N1), e.g. cap_reached.
errors - [String!]!
Example
{
  "communityEvent": CommunityEvent,
  "errorCode": "abc123",
  "errors": ["abc123"]
}

CreateCommunityPayload

Description

Autogenerated return type of CreateCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
Example
{
  "community": Community,
  "errors": ["abc123"]
}

CreateCommunityPostPayload

Description

Autogenerated return type of CreateCommunityPost.

Fields
Field Name Description
errors - [String!]!
post - CommunityPost
Example
{
  "errors": ["abc123"],
  "post": CommunityPost
}

CreateDemoSignInTokenPayload

Description

Autogenerated return type of CreateDemoSignInToken.

Fields
Field Name Description
errors - [String!]!
token - String One-time Clerk sign-in ticket for the demo account; null on failure.
Example
{
  "errors": ["abc123"],
  "token": "xyz789"
}

CreateFeedbackCommentPayload

Description

Autogenerated return type of CreateFeedbackComment.

Fields
Field Name Description
errors - [String!]!
feedbackComment - FeedbackComment
Example
{
  "errors": ["xyz789"],
  "feedbackComment": FeedbackComment
}

CreateFeedbackPostPayload

Description

Autogenerated return type of CreateFeedbackPost.

Fields
Field Name Description
errors - [String!]!
feedbackPost - FeedbackPost
Example
{
  "errors": ["abc123"],
  "feedbackPost": FeedbackPost
}

CreateFeedbackTagPayload

Description

Autogenerated return type of CreateFeedbackTag.

Fields
Field Name Description
errors - [String!]!
feedbackTag - FeedbackTag
Example
{
  "errors": ["abc123"],
  "feedbackTag": FeedbackTag
}

CreatePactPayload

Description

Autogenerated return type of CreatePact.

Fields
Field Name Description
errors - [String!]!
pact - Pact
Example
{
  "errors": ["abc123"],
  "pact": Pact
}

CreateSeasonalEventPayload

Description

Autogenerated return type of CreateSeasonalEvent.

Fields
Field Name Description
errors - [String!]
seasonalEvent - SeasonalEvent
Example
{
  "errors": ["abc123"],
  "seasonalEvent": SeasonalEvent
}

CreateSubCommunityPayload

Description

Autogenerated return type of CreateSubCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
teamReadOnly - Boolean! True only for the grace-period read-only failure — the frontend renders its own "team is read-only" copy for this.
Example
{
  "community": Community,
  "errors": ["abc123"],
  "teamReadOnly": true
}

CreateTeamInvitePayload

Description

Autogenerated return type of CreateTeamInvite.

Fields
Field Name Description
errors - [String!]!
joinUrl - String
teamInvite - TeamInvite
teamReadOnly - Boolean! True only for the grace-period read-only failure — the frontend renders its own "team is read-only" copy for this.
Example
{
  "errors": ["abc123"],
  "joinUrl": "xyz789",
  "teamInvite": TeamInvite,
  "teamReadOnly": false
}

CriticalPathPlayStatus

Description

Today's Critical Path puzzle status for the authenticated user.

Fields
Field Name Description
completed - Boolean! Whether the user has completed today's puzzle.
elapsedSeconds - Int Time taken in seconds; null if not yet completed.
percentile - Int Rank percentile (1-99) among all players today; null when fewer than 10 plays recorded.
puzzleDate - ISO8601Date! UTC calendar date of today's puzzle.
puzzleSeed - Int! YYYYMMDD integer seed identifying today's puzzle; matches frontend dailySeed().
typicalSeconds - Int Median elapsed_seconds of the player's last 10 prior plays at the same grid size; null when fewer than 3 comparable plays exist.
Example
{
  "completed": true,
  "elapsedSeconds": 987,
  "percentile": 123,
  "puzzleDate": ISO8601Date,
  "puzzleSeed": 987,
  "typicalSeconds": 987
}

CriticalPathReminderPreferences

Description

Daily reminder preferences for the Critical Path feature.

Fields
Field Name Description
enabled - Boolean! Whether the user has opted into daily reminders.
timeOfDay - String! Preferred local send time in HH:MM format. Defaults to '08:00'.
timezone - String! User's current IANA timezone string.
timezoneNeedsConfirmation - Boolean! True when reminders are on but the timezone is still the UTC default.
Example
{
  "enabled": false,
  "timeOfDay": "abc123",
  "timezone": "abc123",
  "timezoneNeedsConfirmation": false
}

CriticalPathTheme

Description

A Critical Path visual theme and its unlock requirement.

Fields
Field Name Description
key - String! Theme identifier key (e.g. 'forest').
name - String! Display name shown to the user.
unlockThreshold - Int! Minimum stim_streak_longest required to unlock this theme.
Example
{
  "key": "abc123",
  "name": "xyz789",
  "unlockThreshold": 987
}

DailyUsagePoint

Description

Single day of AI usage data for the daily spend line chart.

Fields
Field Name Description
callCount - Int! Number of AI calls made on this UTC day.
costCents - Int! Total AI spend in cents for this UTC day.
date - String! ISO date (YYYY-MM-DD) in UTC.
tokenCount - Int! Total tokens consumed on this UTC day.
Example
{
  "callCount": 123,
  "costCents": 987,
  "date": "xyz789",
  "tokenCount": 123
}

DashboardPreferences

Description

Dashboard hierarchy view preferences for the user (v4.15).

Fields
Field Name Description
density - String! Dashboard density: standard or detailed. Deprecated; no longer read or sent. Retired with the Standard/Detailed dashboard (261011-n5l); the app no longer reads or sends it (OBJ-4388).
mode - String! Dashboard mode: focus, standard, detailed, or auto.
Example
{
  "density": "xyz789",
  "mode": "abc123"
}

DataImport

Fields
Field Name Description
collisions - [DataImportCollision!]!
commitStage - String! Commit phase in progress: pending, goals, check_ins, streaks or finished.
committedAt - ISO8601DateTime
completionCount - Int! Check-in rows that will import — excludes error rows.
createdAt - ISO8601DateTime!
createdCount - Int!
currentStep - Int!
currentStreak - Int Post-import User#current_streak. Only meaningful once status is committed.
failedCount - Int!
goalCount - Int! Goal rows that will import — excludes error rows and sub-goals.
id - ID!
rowErrors - [DataImportRowIssue!]!
rowWarnings - [DataImportRowIssue!]!
skippedCount - Int!
source - String!
status - String!
totalSteps - Int!
Example
{
  "collisions": [DataImportCollision],
  "commitStage": "xyz789",
  "committedAt": ISO8601DateTime,
  "completionCount": 987,
  "createdAt": ISO8601DateTime,
  "createdCount": 987,
  "currentStep": 987,
  "currentStreak": 987,
  "failedCount": 123,
  "goalCount": 123,
  "id": 4,
  "rowErrors": [DataImportRowIssue],
  "rowWarnings": [DataImportRowIssue],
  "skippedCount": 987,
  "source": "xyz789",
  "status": "abc123",
  "totalSteps": 987
}

DataImportCollision

Fields
Field Name Description
externalId - String
name - String!
Example
{
  "externalId": "xyz789",
  "name": "abc123"
}

DataImportRowIssue

Fields
Field Name Description
file - String!
line - Int!
reason - String!
Example
{
  "file": "xyz789",
  "line": 987,
  "reason": "abc123"
}

DecideHeadCoachActionPayload

Description

Autogenerated return type of DecideHeadCoachAction.

Fields
Field Name Description
action - HeadCoachAction
errors - [String!]!
success - Boolean!
Example
{
  "action": HeadCoachAction,
  "errors": ["xyz789"],
  "success": true
}

DeclineAllyRequestPayload

Description

Autogenerated return type of DeclineAllyRequest.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["abc123"], "success": true}

DeclineGoalSuccessorPayload

Description

Autogenerated return type of DeclineGoalSuccessor.

Fields
Field Name Description
errorCode - String Stable machine code for the failure: the failing interaction's snake_case code (e.g. not_found, taken). Null on success. An open set, so treat an unknown code like any other failure.
errors - [String!]!
goal - Goal
Example
{
  "errorCode": "abc123",
  "errors": ["xyz789"],
  "goal": Goal
}

DeclinePartnerRequestPayload

Description

Autogenerated return type of DeclinePartnerRequest.

Fields
Field Name Description
errors - [String!]!
userAlly - UserAlly
Example
{
  "errors": ["xyz789"],
  "userAlly": UserAlly
}

DeferCoachPickerPayload

Description

Autogenerated return type of DeferCoachPicker.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["abc123"], "success": true}

DeleteAdminUserSegmentPayload

Description

Autogenerated return type of DeleteAdminUserSegment.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": false}

DeleteDemoEntityPayload

Description

Autogenerated return type of DeleteDemoEntity.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["abc123"], "success": false}

DeleteGoalIdeaPayload

Description

Autogenerated return type of DeleteGoalIdea.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": true}

DeleteNotificationPayload

Description

Autogenerated return type of DeleteNotification.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

DeleteOwnAccountPayload

Description

Autogenerated return type of DeleteOwnAccount.

Fields
Field Name Description
appleAuthorizationRequired - Boolean! True when nothing was deleted: retry with appleAuthorizationCode.
appleManualRevokeSuggested - Boolean! True when the user signed in with Apple and their Apple tokens were not revoked: show manual Stop Using Apple ID steps.
errors - [String!]!
success - Boolean!
Example
{
  "appleAuthorizationRequired": true,
  "appleManualRevokeSuggested": true,
  "errors": ["abc123"],
  "success": true
}

DemoCommunityAttributesInput

Description

Permitted fields for inline edit of a demo community.

Fields
Input Field Description
description - String
name - String
private - Boolean
Example
{
  "description": "xyz789",
  "name": "xyz789",
  "private": true
}

DemoDataRunStatus

Description

Progress of an in-flight or recently completed demo-data Sidekiq job.

Fields
Field Name Description
currentStep - Int!
error - String
finishedAt - ISO8601DateTime
scope - String Scope name for ScopeResetJob; null otherwise.
startedAt - ISO8601DateTime
status - String! 'idle' | 'queued' | 'running' | 'succeeded' | 'failed'
totalSteps - Int!
Example
{
  "currentStep": 123,
  "error": "abc123",
  "finishedAt": ISO8601DateTime,
  "scope": "xyz789",
  "startedAt": ISO8601DateTime,
  "status": "abc123",
  "totalSteps": 987
}

DemoGoalAttributesInput

Description

Permitted fields for inline edit of a demo goal.

Fields
Input Field Description
completed - Boolean
content - String
currentAmount - Float
name - String
targetAmount - Float
Example
{
  "completed": true,
  "content": "xyz789",
  "currentAmount": 123.45,
  "name": "abc123",
  "targetAmount": 987.65
}

DemoScopePreview

Description

Live counts of demo-tagged records across the 12 demo-bearing tables.

Fields
Field Name Description
aiArtifacts - Int!
aiEmployees - Int!
aiRuns - Int!
communities - Int!
feedItems - Int!
feedbackComments - Int!
feedbackPosts - Int!
feedbackVotes - Int!
goalEvents - Int!
goals - Int!
totalRecords - Int!
userAllies - Int!
users - Int!
Example
{
  "aiArtifacts": 987,
  "aiEmployees": 123,
  "aiRuns": 987,
  "communities": 987,
  "feedItems": 123,
  "feedbackComments": 123,
  "feedbackPosts": 123,
  "feedbackVotes": 987,
  "goalEvents": 987,
  "goals": 123,
  "totalRecords": 123,
  "userAllies": 987,
  "users": 123
}

DemoUserAttributesInput

Description

Permitted fields for inline edit of a demo user.

Fields
Input Field Description
email - String
firstName - String
lastName - String
Example
{
  "email": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789"
}

DisconnectIntegrationConnectionPayload

Description

Autogenerated return type of DisconnectIntegrationConnection.

Fields
Field Name Description
errors - [String!]!
integrationConnection - IntegrationConnection
Example
{
  "errors": ["abc123"],
  "integrationConnection": IntegrationConnection
}

DiscoveryMember

Description

A minimal, public-safe preview of a community member for discovery surfaces.

Fields
Field Name Description
avatarUrl - String URL for the member's profile photo, or null if none.
displayName - String! The member's display name.
publicId - ID! The member's public identifier.
Example
{
  "avatarUrl": "xyz789",
  "displayName": "xyz789",
  "publicId": "4"
}

DismissAiAutonomyOfferPayload

Description

Autogenerated return type of DismissAiAutonomyOffer.

Fields
Field Name Description
errors - [String!]!
offer - AiAutonomyOffer
Example
{
  "errors": ["xyz789"],
  "offer": AiAutonomyOffer
}

DismissCoachProposalPayload

Description

Autogenerated return type of DismissCoachProposal.

Fields
Field Name Description
coachProposal - CoachProposal The proposal after the call; null if it does not exist for this user.
errors - [String!]!
Example
{
  "coachProposal": CoachProposal,
  "errors": ["abc123"]
}

DismissDashboardHintPayload

Description

Autogenerated return type of DismissDashboardHint.

Fields
Field Name Description
success - Boolean!
Example
{"success": true}

DismissEnneagramCardPayload

Description

Autogenerated return type of DismissEnneagramCard.

Fields
Field Name Description
success - Boolean!
Example
{"success": true}

DismissHabitIntegrationMappingPayload

Description

Autogenerated return type of DismissHabitIntegrationMapping.

Fields
Field Name Description
errors - [String!]!
mapping - HabitIntegrationMapping
Example
{
  "errors": ["abc123"],
  "mapping": HabitIntegrationMapping
}

DismissIntegrationSuggestionPayload

Description

Autogenerated return type of DismissIntegrationSuggestion.

Fields
Field Name Description
errors - [String!]!
Example
{"errors": ["abc123"]}

DismissPactRestartPayload

Description

Autogenerated return type of DismissPactRestart.

Fields
Field Name Description
errors - [String!]!
pact - Pact
Example
{
  "errors": ["xyz789"],
  "pact": Pact
}

DismissPracticeInvitePayload

Description

Autogenerated return type of DismissPracticeInvite.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": true}

DocsAssistantAnswer

Description

Response payload for askDocsQuestion.

Fields
Field Name Description
answer - String Assistant answer text. Null when state is DISABLED.
citations - [DocsAssistantCitation!]! Sources the answer drew from. Always empty when state is REFUSED or DISABLED.
state - DocsAssistantStateEnum! Terminal state discriminator.
Example
{
  "answer": "abc123",
  "citations": [DocsAssistantCitation],
  "state": "ANSWERED"
}

DocsAssistantCitation

Description

A single source the docs assistant drew its answer from — a docs/ path from the committed engineering docs corpus.

Fields
Field Name Description
path - String! Source path within docs/ (e.g. "architecture/authentication.md").
title - String The page title, for display in a source chip.
Example
{
  "path": "abc123",
  "title": "xyz789"
}

DocsAssistantStateEnum

Description

Terminal state of an askDocsQuestion response. Auth failures (no session, an invalid session, or a valid session outside @objectuve.com) and rate-limiting both surface as GraphQL errors instead (see askDocsQuestion field description), not a value here — a refusal and a disabled assistant are both successful responses to an authorized caller, never errors.

Values
Enum Value Description

ANSWERED

The assistant answered the question — see answer and citations.

DISABLED

The docs assistant kill switch is off. answer is null; no LLM call was made.

REFUSED

The question is honestly out of scope for the docs corpus — answer may carry the assistant's refusal text; citations is always empty.
Example
"ANSWERED"

EditHabitIntegrationMappingPayload

Description

Autogenerated return type of EditHabitIntegrationMapping.

Fields
Field Name Description
errors - [String!]!
mapping - HabitIntegrationMapping
Example
{
  "errors": ["abc123"],
  "mapping": HabitIntegrationMapping
}

EncouragePayload

Description

Autogenerated return type of Encourage.

Fields
Field Name Description
alreadyEncouragedToday - Boolean! True when a goal-level target was already encouraged by this giver today — nothing was written.
celebration - EncouragementCelebration Set only when this call earned a celebrated moment (and encouragement_takeover_enabled is on) — the sender-side celebration. Null otherwise.
encouragement - Encouragement
errors - [String!]!
Example
{
  "alreadyEncouragedToday": false,
  "celebration": EncouragementCelebration,
  "encouragement": Encouragement,
  "errors": ["xyz789"]
}

EncouragedBy

Description

Who has encouraged this goal, in any form, with any emoji.

Fields
Field Name Description
encouragements - [Encouragement!]! Every encouragement on this goal, most recent first.
people - [User!]! Distinct people who have encouraged this goal, most recent first.
Arguments
first - Int

Max number of people to return.

peopleCount - Int! Count of distinct people who have encouraged this goal.
Example
{
  "encouragements": [Encouragement],
  "people": [User],
  "peopleCount": 123
}

Encouragement

Description

A single encouragement — one emoji from one person on a goal update or a goal (v4.107, OBJ-5968).

Fields
Field Name Description
createdAtTime - String! Unix timestamp (string) when this encouragement was given.
emoji - String! Unicode emoji character.
goal - Goal! The goal this encouragement targets.
goalEvent - GoalEvent The specific update encouraged, if this is event-level. Null for a goal-level encouragement.
id - ID! Public identifier for this encouragement.
user - User! The person who gave this encouragement.
Example
{
  "createdAtTime": "xyz789",
  "emoji": "xyz789",
  "goal": Goal,
  "goalEvent": GoalEvent,
  "id": "4",
  "user": User
}

EncouragementCelebration

Description

A once-only celebration an encouragement earned for the goal owner — the takeover shown after the owner opens the app or taps the push (v4.107 D7, OBJ-5969).

Fields
Field Name Description
canEncourageBack - Boolean! True when the owner (and only the owner) could encourage the giver back: the giver has a goal visible to the owner and no block exists.
createdAt - ISO8601DateTime! When the moment was earned.
emoji - String! The emoji the giver sent.
giver - User! The ally whose encouragement earned the moment.
goalId - ID! public_id of the top-level goal the moment belongs to.
id - ID! Public identifier for this celebration.
moment - EncouragementMomentEnum! Which moment was earned.
owner - User! The goal owner this moment was earned for.
targetTitle - String! Content of the encouraged update, or the name of the encouraged goal.
Example
{
  "canEncourageBack": true,
  "createdAt": ISO8601DateTime,
  "emoji": "abc123",
  "giver": User,
  "goalId": 4,
  "id": "4",
  "moment": "COMPLETED",
  "owner": User,
  "targetTitle": "abc123"
}

EncouragementMomentEnum

Description

The once-only moment an encouragement earned for a goal owner, highest priority first (v4.107, OBJ-5969).

Values
Enum Value Description

COMPLETED

The goal was completed and this is the first encouragement since.

FIRST

The goal's first encouragement.

MILESTONE

A completed milestone received its first encouragement.

NEWALLY

The first encouragement from this person on any of the owner's goals.
Example
"COMPLETED"

EndPartnershipPayload

Description

Autogenerated return type of EndPartnership.

Fields
Field Name Description
errors - [String!]!
userAlly - UserAlly
Example
{
  "errors": ["abc123"],
  "userAlly": UserAlly
}

EnneagramAssessment

Description

A completed Enneagram personality assessment result.

Fields
Field Name Description
completedAt - ISO8601DateTime! When the assessment was completed.
dominantType - Int! Dominant Enneagram type (1–9).
id - ID! public_id of the assessment.
scores - JSON! Normalized type scores — hash keyed "1".."9", values 0–100.
tritype - String! 3-character tritype string (e.g. "583").
wing - Int! Wing type — adjacent type with the higher score.
Example
{
  "completedAt": ISO8601DateTime,
  "dominantType": 123,
  "id": 4,
  "scores": {},
  "tritype": "xyz789",
  "wing": 123
}

EnqueueClearPayload

Description

Autogenerated return type of EnqueueClear.

Fields
Field Name Description
errors - [String!]!
jobId - String
Example
{
  "errors": ["xyz789"],
  "jobId": "abc123"
}

EnqueueReseedPayload

Description

Autogenerated return type of EnqueueReseed.

Fields
Field Name Description
errors - [String!]!
jobId - String
Example
{
  "errors": ["abc123"],
  "jobId": "abc123"
}

EnqueueScopeResetPayload

Description

Autogenerated return type of EnqueueScopeReset.

Fields
Field Name Description
errors - [String!]!
jobId - String
scope - String
Example
{
  "errors": ["xyz789"],
  "jobId": "abc123",
  "scope": "xyz789"
}

EnsureTodaysCoachMessagePayload

Description

Autogenerated return type of EnsureTodaysCoachMessage.

Fields
Field Name Description
generated - Boolean!
insight - String!
Example
{"generated": false, "insight": "xyz789"}

ExecuteDeletionPayload

Description

Autogenerated return type of ExecuteDeletion.

Fields
Field Name Description
errors - [String!]!
gdprRequest - GdprRequest
Example
{
  "errors": ["abc123"],
  "gdprRequest": GdprRequest
}

ExecuteExportPayload

Description

Autogenerated return type of ExecuteExport.

Fields
Field Name Description
errors - [String!]!
gdprRequest - GdprRequest
Example
{
  "errors": ["xyz789"],
  "gdprRequest": GdprRequest
}

ExportTeamActivityCsvPayload

Description

Autogenerated return type of ExportTeamActivityCsv.

Fields
Field Name Description
csv - String The CSV document, or null when the export failed.
errors - [String!]! Why the export failed, if it did.
Example
{
  "csv": "xyz789",
  "errors": ["abc123"]
}

FeatureImage

Fields
Field Name Description
alt - String!
designAssetId - String!
url - String!
Example
{
  "alt": "abc123",
  "designAssetId": "abc123",
  "url": "abc123"
}

FeatureUsagePoint

Description

Per-feature AI usage aggregation point for the admin dashboard.

Fields
Field Name Description
callCount - Int! Number of AI calls made for this feature over the window.
costCents - Int! Sum of cost_cents over the window, rounded to the nearest cent.
feature - String! Feature name (e.g. coaching, milestones, insights).
tokenCount - Int! Sum of total_tokens over the window.
Example
{
  "callCount": 123,
  "costCents": 987,
  "feature": "abc123",
  "tokenCount": 987
}

FeedAlly

Description

An ally's identity for the feed's weekly badge line.

Fields
Field Name Description
firstName - String! The ally's given name, falling back to their username when blank.
photo - UserPhoto The ally's profile photo.
publicId - ID! Public identifier for the ally.
viewerCheeredToday - Boolean Whether the viewer has already cheered this ally today (any of the ally's goals, any form — same rule as PublicProfileType#viewer_cheered_today). Null for a logged-out viewer.
Example
{
  "firstName": "xyz789",
  "photo": UserPhoto,
  "publicId": 4,
  "viewerCheeredToday": false
}

FeedAllyBadge

Description

An ally's badge, for the feed's weekly collapse.

Fields
Field Name Description
ally - FeedAlly! The ally who earned this badge.
earnedAt - ISO8601DateTime! When the ally earned this badge.
key - String! Badge key matching the UserAction enum action name.
userActionId - ID! Public identifier of the UserAction that recorded this badge.
Example
{
  "ally": FeedAlly,
  "earnedAt": ISO8601DateTime,
  "key": "xyz789",
  "userActionId": "4"
}

FeedEarnedBadge

Description

A badge earned by the check-in or goal event behind a feed row.

Fields
Field Name Description
key - String! Badge key matching the UserAction enum action name.
userActionId - ID! Public identifier of the UserAction that recorded this badge.
Example
{"key": "xyz789", "userActionId": 4}

FeedUpdatePayload

Description

Invalidation ping for the unified activity feed — not a rendered item. The client refetches page 1 through unifiedFeed on receipt.

Fields
Field Name Description
occurredAt - String! Unix timestamp (string) when this ping was triggered.
source - String! Which feed source changed — matches UnifiedFeedItemType#feed_type (ally_activity, community_post, notification, own_activity). A reconnect catch-up ping (unknown source) never reaches the client as a GraphQL payload — it is synthesized client-side by useLiveQuery on socket restore.
Example
{
  "occurredAt": "abc123",
  "source": "abc123"
}

FeedbackCategoryBreakdown

Fields
Field Name Description
count - Int!
name - String!
Example
{"count": 123, "name": "abc123"}

FeedbackComment

Description

A comment on a feedback post.

Fields
Field Name Description
body - String! The comment text.
createdAt - ISO8601DateTime!
id - ID! Public identifier for this comment.
isOfficial - Boolean! Whether this is an official team response.
user - User! The user who wrote this comment.
Example
{
  "body": "xyz789",
  "createdAt": ISO8601DateTime,
  "id": "4",
  "isOfficial": false,
  "user": User
}

FeedbackPost

Description

A user-submitted feedback post (feature request, improvement, bug report).

Fields
Field Name Description
category - String! Category: feature, improvement, bug, or other.
commentCount - Int! Total number of comments.
comments - [FeedbackComment!]! Comments on this post.
createdAt - ISO8601DateTime!
description - String Detailed description of the feedback.
id - ID! Public identifier for this feedback post.
shippedAt - ISO8601DateTime When this post was marked as completed/shipped.
status - String! Status: open, planned, in_progress, completed, or declined.
tags - [FeedbackTag!]! Tags attached to this post.
title - String! Title of the feedback post.
user - User! The user who created this post.
voteCount - Int! Total number of votes.
votedByCurrentUser - Boolean! Whether the current user has voted on this post.
Example
{
  "category": "abc123",
  "commentCount": 123,
  "comments": [FeedbackComment],
  "createdAt": ISO8601DateTime,
  "description": "xyz789",
  "id": 4,
  "shippedAt": ISO8601DateTime,
  "status": "abc123",
  "tags": [FeedbackTag],
  "title": "xyz789",
  "user": User,
  "voteCount": 987,
  "votedByCurrentUser": false
}

FeedbackStats

Description

Aggregate statistics for the feedback board (admin only).

Fields
Field Name Description
categoryBreakdown - [FeedbackCategoryBreakdown!]!
completedPosts - Int!
declinedPosts - Int!
inProgressPosts - Int!
openPosts - Int!
plannedPosts - Int!
postsThisWeek - Int!
topPosts - [FeedbackPost!]!
totalComments - Int!
totalPosts - Int!
totalVotes - Int!
Example
{
  "categoryBreakdown": [FeedbackCategoryBreakdown],
  "completedPosts": 123,
  "declinedPosts": 987,
  "inProgressPosts": 123,
  "openPosts": 123,
  "plannedPosts": 987,
  "postsThisWeek": 987,
  "topPosts": [FeedbackPost],
  "totalComments": 987,
  "totalPosts": 987,
  "totalVotes": 987
}

FeedbackTag

Description

An admin-managed tag that can be applied to feedback posts.

Fields
Field Name Description
archived - Boolean! Whether this tag has been archived.
createdAt - ISO8601DateTime!
description - String Optional description of the tag.
id - ID! Public identifier for this feedback tag.
name - String! Display name of the tag.
position - Int! Display order position.
postsCount - Int! Number of feedback posts carrying this tag.
slug - String! URL-safe slug for this tag.
Example
{
  "archived": true,
  "createdAt": ISO8601DateTime,
  "description": "abc123",
  "id": 4,
  "name": "abc123",
  "position": 987,
  "postsCount": 123,
  "slug": "abc123"
}

FeedbackTheme

Fields
Field Name Description
postCount - Int!
summary - String
title - String
voteTotal - Int!
Example
{
  "postCount": 987,
  "summary": "xyz789",
  "title": "xyz789",
  "voteTotal": 123
}

FeedbackWeeklySummary

Description

Coach-analyzed themed summary of the past week of feedback board posts (admin only).

Fields
Field Name Description
emergingRequests - [String!]!
generatedAt - ISO8601DateTime!
themes - [FeedbackTheme!]!
Example
{
  "emergingRequests": ["xyz789"],
  "generatedAt": ISO8601DateTime,
  "themes": [FeedbackTheme]
}

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65

FollowCommunityPayload

Description

Autogenerated return type of FollowCommunity.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

GdprRequest

Fields
Field Name Description
cascadePreview - CascadePreview
dueBy - ISO8601DateTime!
exportExpiresAt - ISO8601DateTime
exportFileUrl - String
fulfilledAt - ISO8601DateTime
fulfilledBy - User
notes - String
publicId - String!
receivedAt - ISO8601DateTime!
requestType - String!
requestorEmail - String!
status - String!
Example
{
  "cascadePreview": CascadePreview,
  "dueBy": ISO8601DateTime,
  "exportExpiresAt": ISO8601DateTime,
  "exportFileUrl": "xyz789",
  "fulfilledAt": ISO8601DateTime,
  "fulfilledBy": User,
  "notes": "xyz789",
  "publicId": "xyz789",
  "receivedAt": ISO8601DateTime,
  "requestType": "abc123",
  "requestorEmail": "abc123",
  "status": "abc123"
}

GdprRequestConnection

Description

The connection type for GdprRequest.

Fields
Field Name Description
edges - [GdprRequestEdge] A list of edges.
nodes - [GdprRequest] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [GdprRequestEdge],
  "nodes": [GdprRequest],
  "pageInfo": PageInfo
}

GdprRequestEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - GdprRequest The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": GdprRequest
}

GenerateGoalDraftPayload

Description

Autogenerated return type of GenerateGoalDraft.

Fields
Field Name Description
aiRequest - AiRequest The AiRequest tracking this call, resolved by Ai::DispatchAiRequestJob (v4.60). Subscribe to aiRequestUpdate(requestId: id) or poll aiRequest(id:) for the result. Null only on the fallback failure payload.
clarifier - GoalDraftClarifier Present instead of draft when the idea was too vague and allowClarifier was true (v4.109).
draft - GoalDraft
Example
{
  "aiRequest": AiRequest,
  "clarifier": GoalDraftClarifier,
  "draft": GoalDraft
}

GenerateMilestonesPayload

Description

Autogenerated return type of GenerateMilestones.

Fields
Field Name Description
aiRequest - AiRequest The AiRequest tracking this call, resolved by Ai::DispatchAiRequestJob (v4.60). Subscribe to aiRequestUpdate(requestId: id) or poll aiRequest(id:) for the result. Null only on the fallback failure payload.
milestones - [String!]
Example
{
  "aiRequest": AiRequest,
  "milestones": ["abc123"]
}

GetAdvicePayload

Description

Autogenerated return type of GetAdvice.

Fields
Field Name Description
advice - String
aiRequest - AiRequest The AiRequest tracking this call, resolved by Ai::DispatchAiRequestJob (v4.60). Subscribe to aiRequestUpdate(requestId: id) or poll aiRequest(id:) for the result. Null only on the fallback failure payload.
guideCitations - [GuideCitation!]! Validated guide citations for the sync advice reply (v4.106). Empty for an async reply -- read them from the aiRequest result instead.
suggestedActions - [CoachAction!]! Deterministically derived action chips (0-2). No LLM call — derived from goal/mood signals.
Example
{
  "advice": "xyz789",
  "aiRequest": AiRequest,
  "guideCitations": [GuideCitation],
  "suggestedActions": [CoachAction]
}

GetBillingPortalUrlPayload

Description

Autogenerated return type of GetBillingPortalUrl.

Fields
Field Name Description
errors - [String!]!
portalUrl - String
Example
{
  "errors": ["xyz789"],
  "portalUrl": "xyz789"
}

Goal

Description

A user goal with progress events, milestones, and optional community sharing.

Fields
Field Name Description
allEvents - [GoalEvent!]! All progress events including soft-deleted ones.
appLink - String External app URL (https:// or a custom app scheme, e.g. duolingo://) opened on check-in for one-click redirect to another app.
averageCheckInTime - Float Mean hour-of-day (0.0–24.0) in the user's timezone. Null if < 3 completions.
calendarMonth - GoalCalendarMonth! Owner-only calendar for one user-local month (YYYY-MM), between the goal start month and the current month.
Arguments
month - String!

Month as YYYY-MM.

category - GoalCategory The goal category (e.g. fitness, learning, personal).
challenge - GoalChallenge The cause challenge this measure goal tracks (v4.126 D2), or null. Resolves wherever the goal itself resolves.
chapters - [GoalChapter!]! Completed ancestors reached via continuesGoal, oldest first, capped at 10 (v4.113 D2). Visibility-filtered.
checkedInToday - Boolean! Whether the user has checked in today.
collectiveGoalContribution - GoalCollectiveContribution The collective goal this goal is actively contributing to, if any (GOALS-17).
comments - [GoalEventComment!]! Comments left by other users on this goal.
completed - Boolean! Whether the goal has been marked as completed.
completedAtTime - String Unix timestamp (string) when the goal was completed.
completionRate - Float Percentage of expected check-ins completed in the last 30 days.
completionReflection - String Optional free-text reflection captured when the goal was marked complete. Personalizes Coach messaging when present.
content - String Optional longer description or motivation note for the goal.
continuesGoal - Goal The goal this one continues, if any (v4.113 D2). Null if the viewer can't see it.
createdAtTime - String Unix timestamp (string) when the goal was created.
currentAmount - Float Current progress value for quantity-based goals (e.g. 3.2 km).
dayOfWeekDistribution - [Int!]! Check-in counts by day of week [Sun, Mon, Tue, Wed, Thu, Fri, Sat].
daysToUpdate - Int How frequently (in days) the user intends to log progress events.
demo - Boolean! Whether this goal is a demo-tagged record (Phase 30).
dueToday - Boolean! Whether this habit is due for a check-in today.
durationMinutes - Int Optional time-per-session in minutes for habits.
encouragedBy - EncouragedBy! Everyone who has encouraged this goal, across every check-in and the goal itself.
encouragements - [GoalEventEncouragement!]! Encouragement reactions left by other users on this goal. Use encouragedBy (v4.107, OBJ-5968). Served from the unified encouragements table.
events - [GoalEvent!]! Active (non-deleted) progress events. For habits, routine "Checked in!" rows are filtered; only user-authored updates and milestones are returned.
followersCount - Int! Accepted follows on this goal. Drops to zero when the goal becomes private. Owner-only.
fromTemplate - GoalTemplate "From template" badge surface. Null for goals not created from a template.
fromTemplateName - String Name of the template this goal was created from. Null if not template-sourced.
habitCompletions - [HabitCompletion!]! Check-in records for this habit (last 30 days).
habitStreak - Int! Current consecutive check-in streak for this habit.
habitStreakUnit - HabitStreakUnitEnum! Unit habit_streak/longest_habit_streak are counted in: DAY, or WEEK for times_per_week.
identityPrompt - String Optional free-text identity framing (e.g. "Who you're becoming"). Personalizes Coach messaging when present.
imageUrl - String URL of a cover image associated with the goal.
journeyRecap - JourneyRecap The journey from first check-in to last. Owner only, null for anyone else.
kind - GoalType The goal kind/type (e.g. habit, milestone, quantity).
lastCheckedInDate - String ISO date of the most recent check-in.
lifeArea - String The area of life this goal belongs to (e.g. career, health).
lockVersion - Int! Optimistic-lock version, bumped on every updateGoal. Read it when loading the goal for editing and send it back in updateGoal's lockVersion argument to detect a concurrent edit.
longestHabitStreak - Int! All-time longest streak for this habit.
milestones - [Goal!]! Sub-goals (milestones) nested under this goal.
name - String! Display name of the goal (e.g. "Run a 5K").
nonAllyFollowersCount - Int! Follows held by users who are not accepted allies of the owner — the follows a public → allies change drops. Owner-only.
parentGoalId - String public_id of the parent goal if this is a milestone/sub-goal.
pastAttemptContext - String Optional free-text context on a prior attempt at this goal. Personalizes Coach messaging when present.
position - Int Ordinal position within parent goal's roadmap (nullable for top-level goals).
practiceWeek - PracticeWeek Completions/planned slots (OBJ-5452). Owner-only.
practices - [Goal!]! Top-level habits linked to this goal as practices (OBJ-5448).
preBreakHabitStreak - Int! Streak snapshot captured before the last break. Used by Welcome Back and Streak Repair.
private - Boolean! When true, the goal is visible only to its owner.
publicId - ID! URL-safe public identifier for this goal.
quickUpdatePrompts - [String!]! Coach-generated quick-fill chip prompts (0-2), pre-generated at goal creation. Always [] (never null) until the async job lands, or when skipped (milestone, demo, coaching disabled).
recurrenceDays - [String!] Days of the week for weekly/custom_days recurrence (e.g. ["mon", "wed", "fri"]).
recurrenceInterval - Int Number of days between check-ins for interval recurrence.
recurrenceType - String Recurrence pattern: daily, weekly, custom_days, times_per_week, or interval.
sharedWithPartner - Boolean! When true and the goal is private, a confirmed accountability partner can still see it. Has no effect on non-private goals.
status - GoalStatusEnum! Computed status: on_track | needs_attention | paused | completed.
streakFreezesAvailable - Int! Number of streak freeze tokens earned and available.
streakFreezesUsed - Int! Number of streak freeze tokens consumed.
streakRepairEligibleUntil - String ISO 8601 timestamp when the repair window closes. Null when not in window.
streakRepairedCount - Int! Number of times this streak has been repaired or mercied (unified cap).
successorGoal - Goal The goal that continues this one, if accepted (v4.113 D2). Null if the viewer can't see it.
successorOffer - SuccessorOffer The "keep going" offer for this completed measure goal (v4.113 D1). Owner-only; null for anyone else or when ineligible.
supportsGoal - Goal The long goal this top-level habit practices toward, if linked (OBJ-5448).
targetAmount - Float Target value for quantity-based goals (e.g. 5.0 km).
targetDateTime - String Unix timestamp (string) of the target completion date.
totalCheckIns - Int! Total number of actual check-ins ever recorded for this habit.
unit - String Unit label for quantity-based goals (e.g. "km", "pages", "reps").
updatedAtTime - String Unix timestamp (string) when the goal was last updated.
user - User The user who owns this goal.
viewerCheeredToday - Boolean Whether the viewer has sent a goal-scoped cheer (encourage with this goalId) today. Null for a logged-out viewer.
visibility - GoalVisibilityEnum! Who can see this goal: public, allies, or private.
weeklyTarget - Int Check-ins per Monday-start week for a times_per_week habit (1-6); the week is met once this many land, on any days. Null for every other recurrence type.
Example
{
  "allEvents": [GoalEvent],
  "appLink": "xyz789",
  "averageCheckInTime": 987.65,
  "calendarMonth": GoalCalendarMonth,
  "category": GoalCategory,
  "challenge": GoalChallenge,
  "chapters": [GoalChapter],
  "checkedInToday": true,
  "collectiveGoalContribution": GoalCollectiveContribution,
  "comments": [GoalEventComment],
  "completed": true,
  "completedAtTime": "abc123",
  "completionRate": 987.65,
  "completionReflection": "abc123",
  "content": "xyz789",
  "continuesGoal": Goal,
  "createdAtTime": "xyz789",
  "currentAmount": 987.65,
  "dayOfWeekDistribution": [987],
  "daysToUpdate": 123,
  "demo": false,
  "dueToday": false,
  "durationMinutes": 987,
  "encouragedBy": EncouragedBy,
  "encouragements": [GoalEventEncouragement],
  "events": [GoalEvent],
  "followersCount": 987,
  "fromTemplate": GoalTemplate,
  "fromTemplateName": "abc123",
  "habitCompletions": [HabitCompletion],
  "habitStreak": 987,
  "habitStreakUnit": "DAY",
  "identityPrompt": "abc123",
  "imageUrl": "abc123",
  "journeyRecap": JourneyRecap,
  "kind": GoalType,
  "lastCheckedInDate": "abc123",
  "lifeArea": "abc123",
  "lockVersion": 987,
  "longestHabitStreak": 123,
  "milestones": [Goal],
  "name": "xyz789",
  "nonAllyFollowersCount": 987,
  "parentGoalId": "abc123",
  "pastAttemptContext": "xyz789",
  "position": 123,
  "practiceWeek": PracticeWeek,
  "practices": [Goal],
  "preBreakHabitStreak": 987,
  "private": false,
  "publicId": "4",
  "quickUpdatePrompts": ["abc123"],
  "recurrenceDays": ["xyz789"],
  "recurrenceInterval": 987,
  "recurrenceType": "abc123",
  "sharedWithPartner": true,
  "status": "completed",
  "streakFreezesAvailable": 987,
  "streakFreezesUsed": 123,
  "streakRepairEligibleUntil": "abc123",
  "streakRepairedCount": 987,
  "successorGoal": Goal,
  "successorOffer": SuccessorOffer,
  "supportsGoal": Goal,
  "targetAmount": 123.45,
  "targetDateTime": "abc123",
  "totalCheckIns": 987,
  "unit": "xyz789",
  "updatedAtTime": "xyz789",
  "user": User,
  "viewerCheeredToday": true,
  "visibility": "ALLIES",
  "weeklyTarget": 987
}

GoalCalendarDay

Description

One day of a goal calendar month, in the owner's time zone.

Fields
Field Name Description
beforeStart - Boolean! Whether the day is before the goal started.
completion - HabitCompletion The check-in for this day, if any.
date - String! ISO date (user-local).
events - [GoalEvent!]! Non-deleted progress updates dated this day by client timestamp, falling back to creation time. Habit goals omit the automatic "Checked in!" events, matching the goal timeline.
isToday - Boolean! Whether this is the owner's current local date.
loggable - Boolean! Whether a check-in can still be added for this day (late-entry window).
onTimeIfLoggedNow - Boolean! Whether logging this day now would count as on time, with XP and no late label. True for a loggable today, and for yesterday during the grace hours. Drives the late-entry sheet copy only.
scheduled - Boolean! Whether the habit is scheduled this day. Always false for interval habits.
streakEligibleIfLoggedNow - Boolean! Whether logging this day now would still count toward the streak. Drives the late-entry sheet copy only.
Example
{
  "beforeStart": true,
  "completion": HabitCompletion,
  "date": "xyz789",
  "events": [GoalEvent],
  "isToday": false,
  "loggable": true,
  "onTimeIfLoggedNow": false,
  "scheduled": false,
  "streakEligibleIfLoggedNow": false
}

GoalCalendarMilestone

Description

A milestone as it appears on the goal calendar.

Fields
Field Name Description
completed - Boolean! Whether the milestone is completed.
publicId - ID! URL-safe public identifier of the milestone.
targetDate - String! ISO date (user-local) the milestone is due.
title - String! Milestone name.
Example
{
  "completed": false,
  "publicId": 4,
  "targetDate": "abc123",
  "title": "xyz789"
}

GoalCalendarMonth

Description

A goal's calendar for one user-local month. Owner-only.

Fields
Field Name Description
days - [GoalCalendarDay!]! Every day of the month.
milestones - [GoalCalendarMilestone!]! Milestones due within the month.
month - String! The month as YYYY-MM.
startDate - String! ISO date (user-local) the goal started.
summary - GoalCalendarSummary! Month totals.
today - String! The owner's current local date, computed on the server.
Example
{
  "days": [GoalCalendarDay],
  "milestones": [GoalCalendarMilestone],
  "month": "abc123",
  "startDate": "abc123",
  "summary": GoalCalendarSummary,
  "today": "abc123"
}

GoalCalendarNextMilestone

Description

The next incomplete milestone on or after today.

Fields
Field Name Description
publicId - ID! URL-safe public identifier of the milestone.
targetDate - String! ISO date (user-local) the milestone is due.
title - String! Milestone name.
Example
{
  "publicId": "4",
  "targetDate": "xyz789",
  "title": "xyz789"
}

GoalCalendarSummary

Description

Month totals shown above the goal calendar grid.

Fields
Field Name Description
completedCount - Int! Days in the month with a real check-in. Streak-freeze days never count.
nextMilestone - GoalCalendarNextMilestone Next incomplete milestone due today or later, if any.
openCount - Int! Scheduled days up to today with no check-in. Always 0 for interval habits.
Example
{
  "completedCount": 987,
  "nextMilestone": GoalCalendarNextMilestone,
  "openCount": 123
}

GoalCategory

Description

A predefined category for organizing goals (e.g. fitness, learning, personal growth).

Fields
Field Name Description
id - ID! Public identifier for this category.
name - String! Display name of the category.
Example
{"id": 4, "name": "abc123"}

GoalChallenge

Description

A real-world cause challenge (e.g. a 1,500-squat April) tracked as an ordinary measure goal (v4.126 D2). Visible wherever its goal is.

Fields
Field Name Description
causeLabel - String The cause this challenge supports, if any (v4.126 D2).
donationUrl - String Where to donate for this challenge. Owner-only unless the goal is public; null otherwise (v4.126 D2). Opens in the system browser (D6) — the app never shows amounts raised.
endsOn - ISO8601Date! The last day of the challenge window (v4.126 D2).
organizerName - String Who is organizing this challenge, if known (v4.126 D2).
plan - GoalChallengePlan Today's number, days left, and checkpoints (v4.126 D4). Computed per read (one aggregate query) — select it on a single goal, not across a list.
source - GoalChallengeSourceEnum! How this challenge was brought in (v4.126 D2).
sourceUrl - String Where this challenge came from. Owner-only unless the goal is public; null otherwise (v4.126 D2).
startsOn - ISO8601Date! The first day of the challenge window (v4.126 D2).
title - String! The challenge's title (v4.126 D2).
Example
{
  "causeLabel": "xyz789",
  "donationUrl": "abc123",
  "endsOn": ISO8601Date,
  "organizerName": "abc123",
  "plan": GoalChallengePlan,
  "source": "manual",
  "sourceUrl": "abc123",
  "startsOn": ISO8601Date,
  "title": "abc123"
}

GoalChallengeCheckpoint

Description

A milestone amount along the way to a challenge's target (v4.126 D4).

Fields
Field Name Description
amount - Float! The checkpoint amount.
reached - Boolean! Whether logged progress has reached this checkpoint.
Example
{"amount": 123.45, "reached": true}

GoalChallengePlan

Description

The plan for a cause challenge (v4.126 D4): today's number, days left, and checkpoints along the way. Computed in the owner's timezone on every read; never stored.

Fields
Field Name Description
checkpoints - [GoalChallengeCheckpoint!]! Milestone amounts along the way to the target.
daysLeft - Int! Days in the window from today, inclusive.
loggedToday - Float! Amount logged on the owner's local today.
loggedTotal - Float! Total amount logged toward the target so far.
nextCheckpoint - GoalChallengeCheckpoint The next unreached checkpoint, or null once all are reached.
plannedPerDay - Int! The steady per-day pace across the whole window, from day one.
spreadFromMissed - Boolean! Whether today's number is higher than the steady pace because of previously missed days.
state - GoalChallengePlanStateEnum!
todayTarget - Int! Today's number, with any missed days spread across the days left.
Example
{
  "checkpoints": [GoalChallengeCheckpoint],
  "daysLeft": 987,
  "loggedToday": 123.45,
  "loggedTotal": 987.65,
  "nextCheckpoint": GoalChallengeCheckpoint,
  "plannedPerDay": 987,
  "spreadFromMissed": true,
  "state": "active",
  "todayTarget": 987
}

GoalChallengePlanStateEnum

Description

Where a cause challenge stands today (v4.126 D4).

Values
Enum Value Description

active

The challenge window is open.

ended

The window closed; what was logged still counts.

reached

The target was reached.

upcoming

The challenge window hasn't started yet.
Example
"active"

GoalChallengeSourceEnum

Description

How a cause challenge was brought into the app (v4.126 D2).

Values
Enum Value Description

manual

Entered by hand, with no parsed source.

pasted_link

Parsed from a pasted link.

pasted_text

Parsed from pasted plain text.

shared_image

Parsed from an image shared into the app.

shared_link

Parsed from a link shared into the app.

shared_text

Parsed from text shared into the app.
Example
"manual"

GoalChapter

Description

A completed ancestor reached via a goal's successor chain (v4.113 D2). Only ancestors visible to the viewer are returned — one never appears here as a stub.

Fields
Field Name Description
carriedAmount - Float! What this chapter handed on to its successor (D3).
completedAtTime - String Unix timestamp (string) when the ancestor goal was completed.
createdAtTime - String Unix timestamp (string) when the ancestor goal was created.
name - String! The ancestor goal's name.
publicId - ID! public_id of the ancestor goal.
viewerCanOpen - Boolean! Whether the viewer can open this chapter. Always true here — chapters already excludes any ancestor the viewer can't see.
Example
{
  "carriedAmount": 123.45,
  "completedAtTime": "abc123",
  "createdAtTime": "xyz789",
  "name": "abc123",
  "publicId": 4,
  "viewerCanOpen": false
}

GoalCollectiveContribution

Description

The collective goal this personal goal is actively contributing to, if any (GOALS-17).

Fields
Field Name Description
collectiveGoalTitle - String!
teamName - String!
Example
{
  "collectiveGoalTitle": "abc123",
  "teamName": "xyz789"
}

GoalDayContext

Description

The viewer's current local date and account start date, computed on the server.

Fields
Field Name Description
accountStartDate - ISO8601Date! Date the account was created, in the viewer's time zone.
today - ISO8601Date! Current date in the viewer's time zone.
Example
{
  "accountStartDate": ISO8601Date,
  "today": ISO8601Date
}

GoalDayLogEntry

Description

One active goal that was scheduled or logged on a given user-local day.

Fields
Field Name Description
entry - HabitCompletion The check-in for that day, if any.
goal - Goal! The goal.
loggable - Boolean! Whether a check-in can still be added for this goal on this day (late-entry window).
loggedLate - Boolean! Whether the check-in was added after the day it is credited to.
milestones - [GoalCalendarMilestone!]! This goal's milestones due this day.
onTimeIfLoggedNow - Boolean! Whether logging this goal now would count as on time, with XP and no late label.
status - GoalDayStatusEnum! How the goal fared that day.
streakEligibleIfLoggedNow - Boolean! Whether logging this goal now would still count toward the streak.
Example
{
  "entry": HabitCompletion,
  "goal": Goal,
  "loggable": true,
  "loggedLate": false,
  "milestones": [GoalCalendarMilestone],
  "onTimeIfLoggedNow": false,
  "status": "COMPLETED",
  "streakEligibleIfLoggedNow": true
}

GoalDayStatusEnum

Description

How one goal fared on one user-local day.

Values
Enum Value Description

COMPLETED

Checked in.

FROZEN

Covered by a streak freeze.

LOGGED

A non-habit goal with a progress note dated that day.

MISSED

Scheduled on a past day with no check-in.

OPEN

Scheduled today and not yet checked in.
Example
"COMPLETED"

GoalDaySummary

Description

One user-local day across the viewer's active goals.

Fields
Field Name Description
completedCount - Int! Check-ins on this day, excluding streak freezes.
date - String! ISO date (user-local).
hasMilestone - Boolean! Whether any active goal has a milestone due this day.
isFrozen - Boolean! Whether a streak freeze covers any goal on this day.
loggable - Boolean! Whether at least one goal scheduled this day can still take a check-in (late-entry window).
loggedLateCount - Int! Check-ins on this day that were added after the day.
milestoneReached - Boolean! Whether a milestone due this day has been reached.
scheduledCount - Int! Active habit goals scheduled this day.
Example
{
  "completedCount": 987,
  "date": "xyz789",
  "hasMilestone": false,
  "isFrozen": true,
  "loggable": false,
  "loggedLateCount": 987,
  "milestoneReached": true,
  "scheduledCount": 123
}

GoalDraft

Description

A Coach-drafted goal: title, category, kind, target date, why, and milestones.

Fields
Field Name Description
cadence - PracticeCadenceEnum Suggested habit cadence, only for a Habit kind (v4.109).
categoryId - ID Resolved GoalCategory id, or null if the suggested category was unknown.
categoryName - String
kindId - ID Resolved GoalType id, or null if the suggested kind was unknown.
kindName - String
milestones - [String!]!
openCriteria - [SmartCriterionEnum!]! Which of CLEAR and DOABLE Coach judges still open for this sentence; empty when neither (v4.109).
statedWhy - String A reason the user wrote in their own sentence (never a clarifier answer), matching their words up to case, or null. Coach never writes the why (v4.109).
targetAmount - Float Suggested measure target, or null if no count was implied (v4.109).
targetDate - String Suggested ISO8601 target date, or null for habits/ongoing goals.
title - String
unit - String Suggested measure unit, paired with targetAmount (v4.109).
weeklyTarget - Int Suggested check-ins per week, only when cadence is TIMES_PER_WEEK (v4.109).
why - String Coach no longer drafts the why (v4.109) — always null. The user writes it.
Example
{
  "cadence": "DAILY",
  "categoryId": 4,
  "categoryName": "abc123",
  "kindId": "4",
  "kindName": "xyz789",
  "milestones": ["xyz789"],
  "openCriteria": ["CLEAR"],
  "statedWhy": "abc123",
  "targetAmount": 987.65,
  "targetDate": "abc123",
  "title": "xyz789",
  "unit": "abc123",
  "weeklyTarget": 987,
  "why": "xyz789"
}

GoalDraftClarifier

Description

A single clarifying question with tap-to-answer options, returned by generateGoalDraft when the idea was too vague to draft and allowClarifier was true.

Fields
Field Name Description
options - [String!]! Up to 4 short tap-to-answer options.
question - String!
Example
{
  "options": ["abc123"],
  "question": "abc123"
}

GoalEvent

Description

An immutable progress log entry for a goal. Records what the user did and when.

Fields
Field Name Description
amount - Float What this check-in contributed toward a challenge goal (v4.126 D3). Null for events logged against a non-challenge goal, or with no amount.
clientTimestampTime - String Unix timestamp (string) when this event actually occurred on the client device. Null for events logged while online or by legacy clients.
comments - [GoalEventComment!]! Comments from other users on this event.
content - String! Text describing what the user did (e.g. "Ran 3 km in the park").
createdAtTime - String! Unix timestamp (string) when this event was logged.
encouragedBy - [Encouragement!]! Everyone who has encouraged this event, any emoji, most recent first.
encouragements - [GoalEventEncouragement!]! Encouragement reactions from other users on this event. Use encouragedBy (v4.107, OBJ-5968). Served from the unified encouragements table.
goal - Goal The goal this event belongs to.
id - ID! Alias for public_id. Prefer public_id for new integrations.
loggedLate - Boolean! True when this update was added after the day it is dated to ("added later").
media - GoalMedia Optional photo or media attachment for this event.
milestoneName - String Name of the milestone this event was logged against, if any.
mood - String Optional mood snapshot at the time of logging (amazing/happy/calm/meh/tired/low).
publicId - ID! URL-safe public identifier for this event.
reactions - [GoalEventReaction!]! Emoji reactions from other users on this event. Use encouragedBy (v4.107, OBJ-5968). Served from the unified encouragements table.
source - String! Where this event originated: "manual" (user-entered), "integration" (auto-imported from a connected app), or "import" (the initial event of a goal created by a CSV import).
Example
{
  "amount": 123.45,
  "clientTimestampTime": "abc123",
  "comments": [GoalEventComment],
  "content": "xyz789",
  "createdAtTime": "abc123",
  "encouragedBy": [Encouragement],
  "encouragements": [GoalEventEncouragement],
  "goal": Goal,
  "id": 4,
  "loggedLate": false,
  "media": GoalMedia,
  "milestoneName": "xyz789",
  "mood": "xyz789",
  "publicId": "4",
  "reactions": [GoalEventReaction],
  "source": "abc123"
}

GoalEventComment

Description

A comment left by a user on a goal progress event.

Fields
Field Name Description
content - String Text of the comment.
createdAtTime - String Unix timestamp (string) when the comment was posted.
goal - Goal The goal associated with the event being commented on.
id - ID! Public identifier for this comment.
updatedAtTime - String Unix timestamp (string) when the comment was last edited.
user - User The user who wrote the comment.
Example
{
  "content": "xyz789",
  "createdAtTime": "xyz789",
  "goal": Goal,
  "id": 4,
  "updatedAtTime": "abc123",
  "user": User
}

GoalEventEncouragement

Description

An encouragement reaction (like/cheer) left on a goal progress event.

Fields
Field Name Description
comment - String Optional short message included with the encouragement.
createdAtTime - String Unix timestamp (string) when the encouragement was given.
goal - Goal The goal associated with the event being encouraged.
id - ID! Public identifier for this encouragement.
updatedAtTime - String Unix timestamp (string) when it was last updated.
user - User The user who left the encouragement.
Example
{
  "comment": "abc123",
  "createdAtTime": "abc123",
  "goal": Goal,
  "id": 4,
  "updatedAtTime": "xyz789",
  "user": User
}

GoalEventReaction

Description

An emoji reaction on a goal event from another user.

Fields
Field Name Description
createdAtTime - String Unix timestamp (string) when this reaction was created.
emoji - String! Unicode emoji character for this reaction.
id - ID! Public identifier for this reaction.
user - User The user who reacted.
Example
{
  "createdAtTime": "xyz789",
  "emoji": "abc123",
  "id": "4",
  "user": User
}

GoalIdea

Description

A parked goal idea from the Ten -> One flow. Never shown in goals/goalSummary, Coach context, notifications, or XP/badge/streak logic.

Fields
Field Name Description
createdAt - ISO8601DateTime! When this idea was parked.
id - ID! URL-safe public identifier for this idea.
text - String! The idea text, as entered (trimmed, up to 50 characters).
Example
{
  "createdAt": ISO8601DateTime,
  "id": "4",
  "text": "abc123"
}

GoalMedia

Description

A media attachment (image) associated with a goal progress event.

Fields
Field Name Description
id - ID! Public identifier for this media record.
imageUrl - String URL of the attached image.
name - String Optional descriptive name or caption for the image.
thumbUrl - String 144x144 square thumbnail URL. Falls back to imageUrl until the variant is processed.
tileUrl - String Thumbnail URL fitting within 800x800. Falls back to imageUrl until the variant is processed.
Example
{
  "id": 4,
  "imageUrl": "xyz789",
  "name": "abc123",
  "thumbUrl": "xyz789",
  "tileUrl": "xyz789"
}

GoalMotivationProfile

Description

Goal Motivation Snapshot answers captured during onboarding.

Fields
Field Name Description
challenge - String Biggest challenge: starting, staying_consistent, momentum_after_setbacks, knowing_progress.
completedAt - String ISO 8601 timestamp of last save.
experience - String Prior goal-tracking experience: never, a_few_times, many_still_going, many_struggled.
socialContext - String Preferred social context: solo, friend_or_partner, team_or_group.
workTime - String Preferred time to work on goals: morning, afternoon, evening, varies.
Example
{
  "challenge": "xyz789",
  "completedAt": "xyz789",
  "experience": "abc123",
  "socialContext": "xyz789",
  "workTime": "abc123"
}

GoalProgressData

Description

Progress visualization data for a goal.

Fields
Field Name Description
averagePerWeek - Float! Average events per week in the lookback period.
dataPoints - [ProgressDataPoint!]! Event frequency data grouped by period.
pace - String! Current pace status: ahead, on_track, or behind.
streakData - [ProgressDataPoint!]! Habit streak completion data (habits only).
totalEvents - Int! Total number of events in the lookback period.
Example
{
  "averagePerWeek": 123.45,
  "dataPoints": [ProgressDataPoint],
  "pace": "abc123",
  "streakData": [ProgressDataPoint],
  "totalEvents": 987
}

GoalRefinementSuggestion

Description

A single field-level refinement suggestion for a not-yet-saved goal.

Fields
Field Name Description
criterion - SmartCriterionEnum Which SMART-read letter this suggestion fixes, when applicable (v4.109). Null for milestone/description.
field - String! One of: title, description, target_date, milestone, measure, why, cadence. measure/why/cadence only appear when smart: true (v4.109).
issue - String!
suggestedValue - String! The concrete replacement value. For field: "why", this is the same question as "suggestion" — never a ghostwritten answer; the client must only focus the field, never write this value into it.
suggestion - String!
Example
{
  "criterion": "CLEAR",
  "field": "abc123",
  "issue": "abc123",
  "suggestedValue": "xyz789",
  "suggestion": "xyz789"
}

GoalStatusEnum

Description

Computed readiness status for a goal.

Values
Enum Value Description

completed

Goal has been marked as completed.

needs_attention

Goal is overdue or falling behind on updates.

on_track

Goal is progressing normally.

paused

Goal has had no activity for 30+ days.
Example
"completed"

GoalSummary

Description

Aggregated statistics for the current user's goals.

Fields
Field Name Description
avgProgress - Float Average progress percentage across active, trackable goals (0–100). Null when no active goal has an observable progress signal (habit rate, roadmap, or target amount) — never a fabricated 0.
completedCount - Int! Number of completed goals.
completedThisYearCount - Int! Number of goals completed since Jan 1 in the viewer timezone.
needAttentionCount - Int! Number of active goals in needs_attention status.
onTrackCount - Int! Number of active goals in on_track status.
totalGoals - Int! Total number of top-level goals.
Example
{
  "avgProgress": 123.45,
  "completedCount": 123,
  "completedThisYearCount": 987,
  "needAttentionCount": 987,
  "onTrackCount": 987,
  "totalGoals": 987
}

GoalTemplate

Description

A curated goal template users can adopt. Content is placeholder until Phase 85 (Penny).

Fields
Field Name Description
category - GoalCategory Optional goal category associated with this template.
description - String! Longer description or motivation copy for this template.
displayOrder - Int! Display position within its theme group (ascending).
estimatedDurationDays - Int! Approximate number of days to complete this goal.
imageUrl - String Optional cover image URL. Null until Phase 85 canonical content pass.
kind - GoalType The goal kind this template creates (v4.93 Phase 7).
milestones - [GoalTemplateMilestone!]! Ordered milestone steps stored as JSONB.
name - String! Display name of the template (e.g. "TODO(content): Run a 5K").
practices - [GoalTemplatePractice!]! Bundled practices (≤2) created alongside the goal (v4.93 Phase 7).
publicId - ID! URL-safe public identifier for this template.
theme - String! Grouping theme: fitness | learning | financial | habit_wellness.
Example
{
  "category": GoalCategory,
  "description": "xyz789",
  "displayOrder": 987,
  "estimatedDurationDays": 987,
  "imageUrl": "abc123",
  "kind": GoalType,
  "milestones": [GoalTemplateMilestone],
  "name": "abc123",
  "practices": [GoalTemplatePractice],
  "publicId": "4",
  "theme": "abc123"
}

GoalTemplateMilestone

Description

A milestone entry stored in a GoalTemplate milestones JSONB column.

Fields
Field Name Description
daysOffsetFromStart - Int! Number of days after the goal start date when this milestone is expected.
name - String! Display name of this milestone step.
order - Int! Zero-based position within the milestone sequence.
Example
{
  "daysOffsetFromStart": 123,
  "name": "abc123",
  "order": 987
}

GoalTemplatePractice

Description

A bundled practice entry stored in a GoalTemplate practices JSONB column (v4.93 Phase 7).

Fields
Field Name Description
cadence - PracticeCadenceEnum! How often this practice repeats.
name - String! Display name of this practice.
Example
{"cadence": "DAILY", "name": "abc123"}

GoalType

Description

A goal kind/type that determines how progress is tracked (e.g. habit, milestone, quantity).

Fields
Field Name Description
description - String! Explanation of how goals of this type work.
displayNumber - Int Ordering hint for display in the UI.
id - ID! Integer database identifier for this goal type (reference table, not a public_id).
name - String! Display name of the goal type (e.g. "Habit", "Milestone", "Quantity").
Example
{
  "description": "abc123",
  "displayNumber": 123,
  "id": 4,
  "name": "abc123"
}

GoalVisibilityEnum

Description

Who can see a goal: everyone, accepted allies only, or just the owner.

Values
Enum Value Description

ALLIES

Visible to the owner and their accepted allies.

PRIVATE

Visible only to the owner.

PUBLIC

Visible to everyone.
Example
"ALLIES"

GrantAchievementDebugPayload

Description

Autogenerated return type of GrantAchievementDebug.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["abc123"], "success": false}

GrowthDataPoint

Description

Daily growth metrics for users and goals

Fields
Field Name Description
date - String!
goals - Int!
users - Int!
Example
{
  "date": "abc123",
  "goals": 987,
  "users": 987
}

GuideAssistantAnswer

Description

Response payload for askGuideQuestion.

Fields
Field Name Description
answer - String Assistant answer text. Null when state is DISABLED.
citations - [GuideAssistantCitation!]! Sources the answer drew from. Always empty when state is REFUSED or DISABLED.
state - GuideAssistantStateEnum! Terminal state discriminator.
Example
{
  "answer": "xyz789",
  "citations": [GuideAssistantCitation],
  "state": "ANSWERED"
}

GuideAssistantCitation

Description

A single source the guide assistant drew its answer from — always a real help.objectuve.com page from the committed guide corpus.

Fields
Field Name Description
path - String! Resolvable help.objectuve.com URL for this source.
slug - String! Guide page slug (e.g. "goals").
title - String! The page title, for display in a source chip.
Example
{
  "path": "abc123",
  "slug": "xyz789",
  "title": "xyz789"
}

GuideAssistantStateEnum

Description

Terminal state of an askGuideQuestion response. Rate-limiting surfaces as a RATE_LIMITED GraphQL error instead (see askGuideQuestion field description), not a value here — a refusal and a disabled assistant are both successful responses, never errors.

Values
Enum Value Description

ANSWERED

The assistant answered the question — see answer and citations.

DISABLED

The docs assistant kill switch is off. answer is null; no LLM call was made.

REFUSED

The question is honestly out of scope for the guide — answer may carry the assistant's refusal text; citations is always empty.
Example
"ANSWERED"

GuideCitation

Description

A validated citation into the Objectuve help guide, resolved for a read_guide chip.

Fields
Field Name Description
anchor - String Section anchor; null for a page-level citation.
pageTitle - String! The guide page's H1.
sectionTitle - String The section heading; null for a page-level citation.
slug - String! Guide page slug.
Example
{
  "anchor": "abc123",
  "pageTitle": "abc123",
  "sectionTitle": "xyz789",
  "slug": "xyz789"
}

HabitCompletion

Description

A single habit check-in record for a specific date.

Fields
Field Name Description
completedDate - String! ISO date string for the check-in date.
createdAt - String! ISO timestamp when the check-in was recorded.
historySource - IntegrationHistorySource Where an INTEGRATION_HISTORY day came from (provider, activity type, duration), from its linked history-only activity (v4.130 BF-09). Null for any other source, when that activity no longer exists, or for anyone but the owner.
id - ID! Internal identifier for the completion record.
loggedLate - Boolean! True when this check-in was added after the day it is credited to ("added later").
note - String Optional one-sentence micro-journal note for this check-in (max 280 characters). Private — visible only to the completion's owner, never on community/ally/team surfaces.
rescueKind - HabitCompletionRescueKindEnum Whether a rescued day was a freeze or a repair. Null for ordinary check-ins.
source - HabitCompletionSourceEnum! Where this completion came from. INTEGRATION_HISTORY is imported history that is not a check-in — it earns nothing.
streakFreezeUsed - Boolean! Whether a streak freeze was used for this date.
Example
{
  "completedDate": "xyz789",
  "createdAt": "abc123",
  "historySource": IntegrationHistorySource,
  "id": "4",
  "loggedLate": false,
  "note": "xyz789",
  "rescueKind": "FREEZE",
  "source": "IMPORT",
  "streakFreezeUsed": true
}

HabitCompletionRescueKindEnum

Description

How a rescued day was covered: a streak freeze, or a repair (repair, mercy or insurance).

Values
Enum Value Description

FREEZE

Covered by a streak freeze.

REPAIR

Covered by a streak repair, mercy restore or insurance claim.
Example
"FREEZE"

HabitCompletionSourceEnum

Description

Where a habit completion came from.

Values
Enum Value Description

IMPORT

Brought in by a CSV import.

INTEGRATION_HISTORY

A pre-connect activity imported as history (D2) — it earns nothing.

MANUAL

A check-in the user logged themselves.
Example
"IMPORT"

HabitIntegrationMapping

Description

Links a connected provider activity type to a habit (Goal), with a confidence score.

Fields
Field Name Description
autoCheckEnabled - Boolean! Whether matching activities auto-check-in this habit.
confidenceScore - Float Mapping confidence, 0–1, from the auto-mapping engine.
goal - Goal! The habit this provider activity type maps to.
integrationConnection - IntegrationConnection! The connection this mapping belongs to.
lastAutoCheckedInOn - ISO8601Date Most recent progression-earning auto check-in for this mapping's goal/provider pair, in the user's local date (OBJ-6493 D8).
pact - Pact v4.129 (GQL-09, S11) — the Pact this mapping ticks a rule in. Null for a plain habit mapping.
pactRule - PactRule v4.129 (GQL-09, S11) — set only for a Pact-rule link. Null for a plain habit mapping.
providerActivityType - String! Provider-specific activity type (e.g. "Strava.run").
publicId - ID! URL-safe public identifier for this mapping.
Example
{
  "autoCheckEnabled": false,
  "confidenceScore": 123.45,
  "goal": Goal,
  "integrationConnection": IntegrationConnection,
  "lastAutoCheckedInOn": ISO8601Date,
  "pact": Pact,
  "pactRule": PactRule,
  "providerActivityType": "xyz789",
  "publicId": "4"
}

HabitLinkSummary

Description

How many of the current user's habits a provider could check off (OBJ-6493 D7).

Fields
Field Name Description
linkedCount - Int! Candidate habits with at least one non-deleted mapping on a non-deleted connection — a paused connection still counts.
totalCount - Int! Candidate habits: open, recurring, not a joined Pact's linked goal.
Example
{"linkedCount": 987, "totalCount": 987}

HabitStreakUnitEnum

Description

Unit habit_streak/longest_habit_streak are counted in: consecutive days for every recurrence type except times_per_week, which counts consecutive weeks where its weekly target was met.

Values
Enum Value Description

DAY

Consecutive calendar days with a check-in.

WEEK

Consecutive Monday-start weeks where the habit's weekly target was met.
Example
"DAY"

HeadCoachAction

Fields
Field Name Description
affectedCount - Int
approvalExpiresAt - ISO8601DateTime
approvalRequirements - JSON Staged actions: { reason_required, typed_count, step_up }.
decidedAt - ISO8601DateTime
id - ID!
status - String! executed | failed | undone | staged | rejected | expired.
undoUntil - ISO8601DateTime
undoneAt - ISO8601DateTime
Example
{
  "affectedCount": 987,
  "approvalExpiresAt": ISO8601DateTime,
  "approvalRequirements": {},
  "decidedAt": ISO8601DateTime,
  "id": "4",
  "status": "xyz789",
  "undoUntil": ISO8601DateTime,
  "undoneAt": ISO8601DateTime
}

HeadCoachBrief

Fields
Field Name Description
doneToday - HeadCoachBriefDoneToday!
failedRuns - HeadCoachBriefFailedRuns!
gdprDeadlines - HeadCoachBriefGdpr!
generatedAt - ISO8601DateTime!
health - HeadCoachBriefHealth!
needsYou - [HeadCoachBriefItem!]!
running - HeadCoachBriefRunning!
Example
{
  "doneToday": HeadCoachBriefDoneToday,
  "failedRuns": HeadCoachBriefFailedRuns,
  "gdprDeadlines": HeadCoachBriefGdpr,
  "generatedAt": ISO8601DateTime,
  "health": HeadCoachBriefHealth,
  "needsYou": [HeadCoachBriefItem],
  "running": HeadCoachBriefRunning
}

HeadCoachBriefDoneToday

Fields
Field Name Description
count - Int! Head Coach turns this admin completed today.
Example
{"count": 123}

HeadCoachBriefFailedRuns

Fields
Field Name Description
count - Int!
items - [HeadCoachBriefRun!]!
Example
{"count": 987, "items": [HeadCoachBriefRun]}

HeadCoachBriefGdpr

Fields
Field Name Description
items - [HeadCoachGdprDeadline!]!
total - Int!
Example
{"items": [HeadCoachGdprDeadline], "total": 987}

HeadCoachBriefHealth

Fields
Field Name Description
databaseReachable - Boolean!
deployRevision - String
deployTimestamp - String
litellmReachable - Boolean!
ok - Boolean!
redisReachable - Boolean!
sidekiqReachable - Boolean!
Example
{
  "databaseReachable": true,
  "deployRevision": "xyz789",
  "deployTimestamp": "xyz789",
  "litellmReachable": false,
  "ok": false,
  "redisReachable": false,
  "sidekiqReachable": false
}

HeadCoachBriefItem

Fields
Field Name Description
count - Int!
key - String!
label - String!
route - String
Example
{
  "count": 123,
  "key": "abc123",
  "label": "xyz789",
  "route": "xyz789"
}

HeadCoachBriefRun

Fields
Field Name Description
employeeName - String
error - String!
failedAt - ISO8601DateTime!
id - ID!
Example
{
  "employeeName": "abc123",
  "error": "abc123",
  "failedAt": ISO8601DateTime,
  "id": 4
}

HeadCoachBriefRunning

Fields
Field Name Description
activeTurn - Boolean! Whether this admin has a queued/running Head Coach turn.
count - Int!
items - [HeadCoachBriefRunningItem!]!
Example
{
  "activeTurn": false,
  "count": 123,
  "items": [HeadCoachBriefRunningItem]
}

HeadCoachBriefRunningItem

Fields
Field Name Description
employeeName - String
id - ID!
startedAt - ISO8601DateTime
Example
{
  "employeeName": "abc123",
  "id": 4,
  "startedAt": ISO8601DateTime
}

HeadCoachBulkRun

Fields
Field Name Description
actionId - ID! public_id of the start_bulk_run action; this is the run id.
control - String! running | paused | stopped. A missing control reads as stopped.
cursor - Int! Items processed so far.
errors - [String!]! The first failures, capped at 20.
failed - Int!
finishedAt - ISO8601DateTime
itemTool - String!
startedAt - ISO8601DateTime
status - String! queued | running | paused | completed | stopped.
succeeded - Int!
total - Int!
Example
{
  "actionId": "4",
  "control": "xyz789",
  "cursor": 987,
  "errors": ["abc123"],
  "failed": 123,
  "finishedAt": ISO8601DateTime,
  "itemTool": "xyz789",
  "startedAt": ISO8601DateTime,
  "status": "xyz789",
  "succeeded": 987,
  "total": 987
}

HeadCoachBulkRunCommandEnum

Description

What to do to a Head Coach bulk run.

Values
Enum Value Description

PAUSE

RESUME

STOP

Example
"PAUSE"

HeadCoachConversation

Fields
Field Name Description
activeTurn - HeadCoachTurn The queued/running turn, if any, so a reopened panel resumes polling.
createdAt - ISO8601DateTime!
id - ID!
lastTurnAt - ISO8601DateTime
messages - [HeadCoachMessage!]!
title - String
Example
{
  "activeTurn": HeadCoachTurn,
  "createdAt": ISO8601DateTime,
  "id": 4,
  "lastTurnAt": ISO8601DateTime,
  "messages": [HeadCoachMessage],
  "title": "xyz789"
}

HeadCoachGdprDeadline

Fields
Field Name Description
dueBy - ISO8601DateTime!
id - ID!
overdue - Boolean!
requestType - String!
status - String!
Example
{
  "dueBy": ISO8601DateTime,
  "id": 4,
  "overdue": true,
  "requestType": "abc123",
  "status": "xyz789"
}

HeadCoachMessage

Fields
Field Name Description
createdAt - ISO8601DateTime!
id - ID!
kind - String! user | coach | steps | navigate | chart | brief | receipt | approval | run.
payloadJson - String!
role - String! user | assistant.
seq - Int!
Example
{
  "createdAt": ISO8601DateTime,
  "id": "4",
  "kind": "abc123",
  "payloadJson": "abc123",
  "role": "xyz789",
  "seq": 123
}

HeadCoachTurn

Fields
Field Name Description
conversationId - ID!
createdAt - ISO8601DateTime!
errorCode - String
id - ID!
iterations - Int!
status - String! queued | running | completed | failed | cancelled.
Example
{
  "conversationId": 4,
  "createdAt": ISO8601DateTime,
  "errorCode": "abc123",
  "id": "4",
  "iterations": 987,
  "status": "xyz789"
}

HeadCoachTurnPoll

Fields
Field Name Description
messages - [HeadCoachMessage!]!
turn - HeadCoachTurn!
Example
{
  "messages": [HeadCoachMessage],
  "turn": HeadCoachTurn
}

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4

ISO8601Date

Description

An ISO 8601-encoded date

Example
ISO8601Date

ISO8601DateTime

Description

An ISO 8601-encoded datetime

Example
ISO8601DateTime

InsightPack

Description

A daily AI coaching insight card for a specific app page.

Fields
Field Name Description
ctaLabel - String Button label, or null if no action is required.
id - String! Stable ID for client-side dismissal state tracking.
message - String! Actionable insight text (max 2 sentences).
page - String! Page key this insight targets (e.g. "dashboard", "goals").
title - String! Short card title (max 8 words).
type - String! Card type: tip, action, insight, or celebration.
Example
{
  "ctaLabel": "xyz789",
  "id": "abc123",
  "message": "xyz789",
  "page": "abc123",
  "title": "xyz789",
  "type": "abc123"
}

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987

IntegrationActivity

Description

A single fetched activity from a connected provider (a Strava run, a Chess.com game, ...).

Fields
Field Name Description
activityType - String! Normalized activity type (e.g. "run", "chess_blitz").
checkedAt - ISO8601DateTime When this activity was auto-checked-in, if ever.
distanceKm - Float Distance covered, in kilometers, if applicable.
durationMinutes - Int Duration of the activity, in minutes.
publicId - ID! URL-safe public identifier for this activity.
timestamp - ISO8601DateTime! When the activity occurred.
Example
{
  "activityType": "abc123",
  "checkedAt": ISO8601DateTime,
  "distanceKm": 987.65,
  "durationMinutes": 123,
  "publicId": "4",
  "timestamp": ISO8601DateTime
}

IntegrationBackfillStatusEnum

Description

State of a connection's one-time 30-day history backfill.

Values
Enum Value Description

DONE

The backfill job finished successfully.

FAILED

The backfill job ended in failure (exhausted retries or a terminal error).

PENDING

The backfill job has not finished yet.
Example
"DONE"

IntegrationConnection

Description

A user's link to a connected provider. Access/refresh tokens are never exposed here.

Fields
Field Name Description
createdAt - ISO8601DateTime! When this connection was created.
externalUsername - String Provider account handle (e.g. Chess.com username), if applicable.
historyBackfill - IntegrationHistoryBackfill v4.130 (BF-09) — the 30-day history backfill state. Null when integration_backfill_enabled is off for the owner, or the connection predates v4.130.
integrationProvider - IntegrationProvider! The connected provider.
pactRuleLinkCount - Int! v4.129 (GQL-09, S11) — how many of this connection's mappings tick a Pact rule (not a plain habit).
publicId - ID! URL-safe public identifier for this connection.
status - String! Connection status: active, paused, or error.
syncedAt - ISO8601DateTime When activity was last successfully fetched.
tokenExpiresAt - ISO8601DateTime When the current access token expires, if applicable.
Example
{
  "createdAt": ISO8601DateTime,
  "externalUsername": "abc123",
  "historyBackfill": IntegrationHistoryBackfill,
  "integrationProvider": IntegrationProvider,
  "pactRuleLinkCount": 987,
  "publicId": 4,
  "status": "abc123",
  "syncedAt": ISO8601DateTime,
  "tokenExpiresAt": ISO8601DateTime
}

IntegrationHistoryBackfill

Description

A connection's one-time 30-day history backfill state.

Fields
Field Name Description
daysImported - Int! The integration_history completions (habit-days) written for this connection.
status - IntegrationBackfillStatusEnum! PENDING, DONE, or FAILED.
Example
{"daysImported": 123, "status": "DONE"}

IntegrationHistorySource

Description

Where an INTEGRATION_HISTORY day came from: provider, activity type, and duration.

Fields
Field Name Description
activityType - String! The provider's own activity type string.
durationMinutes - Int Duration in minutes, null when the provider has no duration (e.g. a weigh-in).
providerName - String! Display name of the provider (e.g. "Strava").
providerSlug - String! Stable machine-readable provider slug (e.g. "strava").
Example
{
  "activityType": "abc123",
  "durationMinutes": 987,
  "providerName": "abc123",
  "providerSlug": "xyz789"
}

IntegrationProvider

Description

A connectable third-party service (Strava, Chess.com, ...).

Fields
Field Name Description
authType - String! How connections authenticate: oauth, api_key, or none.
description - String Short description of what this provider syncs.
logoUrl - String URL of the provider logo, if any.
name - String! Display name (e.g. "Strava").
providerSlug - String! Stable machine-readable slug (e.g. "strava").
publicId - ID! URL-safe public identifier for this provider.
Example
{
  "authType": "xyz789",
  "description": "abc123",
  "logoUrl": "xyz789",
  "name": "abc123",
  "providerSlug": "abc123",
  "publicId": 4
}

IntegrationSuggestion

Description

A habit that a not-yet-connected provider could check off on its own (OBJ-6493 D4/D5).

Fields
Field Name Description
goal - Goal! The habit the suggestion starts from.
id - ID! Stable identifier for this suggestion, formatted as "goalPublicId:providerSlug".
provider - IntegrationProvider! The not-yet-connected provider.
providerActivityType - String! What the post-connect review pre-selects (e.g. "run").
reason - String! One-line, server-rendered reason (UI-SPEC § Reason copy table).
Example
{
  "goal": Goal,
  "id": "4",
  "provider": IntegrationProvider,
  "providerActivityType": "xyz789",
  "reason": "abc123"
}

InviteAllyToCommunityPayload

Description

Autogenerated return type of InviteAllyToCommunity.

Fields
Field Name Description
alreadyInvited - Boolean!
errors - [String!]!
success - Boolean!
Example
{
  "alreadyInvited": false,
  "errors": ["abc123"],
  "success": false
}

InviteToPactPayload

Description

Autogenerated return type of InviteToPact.

Fields
Field Name Description
errors - [String!]!
pact - Pact
pactMembership - PactMembership
Example
{
  "errors": ["xyz789"],
  "pact": Pact,
  "pactMembership": PactMembership
}

JSON

Description

Represents untyped JSON

Example
{}

JoinCommunityChallengePayload

Description

Autogenerated return type of JoinCommunityChallenge.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

JoinCommunityPayload

Description

Autogenerated return type of JoinCommunity.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

JoinSeasonalEventPayload

Description

Autogenerated return type of JoinSeasonalEvent.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

JoinSubCommunityPayload

Description

Autogenerated return type of JoinSubCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
Example
{
  "community": Community,
  "errors": ["abc123"]
}

JourneyCheckIn

Description

A check-in that opens or closes a journey recap (v4.108 D8).

Fields
Field Name Description
excerpt - String The owner's note, at most 140 characters. Null when the check-in has no note.
occurredOn - ISO8601Date! The owner's local day of the check-in.
publicId - ID! Public identifier of the check-in.
Example
{
  "excerpt": "xyz789",
  "occurredOn": ISO8601Date,
  "publicId": "4"
}

JourneyRecap

Description

A goal or milestone's journey from first check-in to last. The owner's own view (v4.108 D8).

Fields
Field Name Description
checkInCount - Int! Earned check-ins, including those on the milestones of a top-level goal.
daysTaken - Int! First check-in to last, inclusive. With no check-ins, creation to completion.
encouragerCount - Int! Distinct allies who encouraged this journey. Blocked users are excluded.
firstCheckIn - JourneyCheckIn The earliest check-in. Null when there are none.
lastCheckIn - JourneyCheckIn The latest check-in. Null when there are none.
segments - [JourneySegment!]! The journey in order, bucketed to at most max segments.
Arguments
max - Int

Most segments to return, up to 60. Defaults to 60.

streakAtFinish - Int The owner's streak on the day the goal completed. Null until it completes.
Example
{
  "checkInCount": 987,
  "daysTaken": 123,
  "encouragerCount": 987,
  "firstCheckIn": JourneyCheckIn,
  "lastCheckIn": JourneyCheckIn,
  "segments": [JourneySegment],
  "streakAtFinish": 987
}

JourneySegment

Description

One segment of a journey ring: a day, or a bucket of days once a goal outgrows the ring (v4.108 D8).

Fields
Field Name Description
checkInCount - Int! Check-ins in this segment. On a goal recap, a segment with none is unlit.
encouragedBy - [User!]! Up to 3 allies who encouraged this segment. Blocked users are excluded.
occurredOn - ISO8601Date! The owner's local day this segment starts on.
Example
{
  "checkInCount": 123,
  "encouragedBy": [User],
  "occurredOn": ISO8601Date
}

LeaveCommunityChallengePayload

Description

Autogenerated return type of LeaveCommunityChallenge.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

LeaveCommunityPayload

Description

Autogenerated return type of LeaveCommunity.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

LeaveSeasonalEventPayload

Description

Autogenerated return type of LeaveSeasonalEvent.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

LeaveSubCommunityPayload

Description

Autogenerated return type of LeaveSubCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
Example
{
  "community": Community,
  "errors": ["xyz789"]
}

LinkPactRuleSyncPayload

Description

Autogenerated return type of LinkPactRuleSync.

Fields
Field Name Description
errors - [String!]!
pactRule - PactRule
Example
{
  "errors": ["xyz789"],
  "pactRule": PactRule
}

LinkPracticePayload

Description

Autogenerated return type of LinkPractice.

Fields
Field Name Description
errors - [String!]!
goal - Goal
practice - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal,
  "practice": Goal
}

MappingProposal

Description

A freshly re-scored mapping suggestion from Integrations::MapIncomingActivity.

Fields
Field Name Description
confidenceScore - Float! Score from 0-1.
decision - String! "auto", "propose", or "ignore".
goal - Goal The best-matching habit, or null when the decision is "ignore".
integrationActivity - IntegrationActivity! The activity being scored.
Example
{
  "confidenceScore": 123.45,
  "decision": "abc123",
  "goal": Goal,
  "integrationActivity": IntegrationActivity
}

MarkReverseNudgeShownPayload

Description

Autogenerated return type of MarkReverseNudgeShown.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": false}

MarkSupporterMomentShownPayload

Description

Autogenerated return type of MarkSupporterMomentShown.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": false}

MarketingCapability

Description

A plain-language skill a marketing agent can be given.

Fields
Field Name Description
appliesTo - [String!]! Output kinds this capability is relevant to.
description - String!
label - String!
locked - Boolean! True when a non-admin cannot switch this capability off.
slug - String!
Example
{
  "appliesTo": ["xyz789"],
  "description": "xyz789",
  "label": "xyz789",
  "locked": true,
  "slug": "xyz789"
}

MarketingCrewBudget

Description

Aggregate monthly budget shared by every marketing-crew agent.

Fields
Field Name Description
limitCents - Int!
resetsOn - ISO8601Date!
spentCents - Int!
Example
{
  "limitCents": 123,
  "resetsOn": ISO8601Date,
  "spentCents": 987
}

MarketingSocialChannel

Description

A supported social network and the Buffer account it maps to (read from the cached sync).

Fields
Field Name Description
avatarUrl - String
checkedAt - ISO8601DateTime When Buffer was last synced.
displayName - String
handle - String The account's Buffer name, when known.
key - String! Our channel key: x, linkedin or facebook.
overrideMatchesBuffer - Boolean! True when no fixed id is set, or it equals the connected Buffer account.
source - MarketingSocialChannelSourceEnum! Where the channel id comes from: a fixed id, Buffer, or nowhere.
status - MarketingSocialChannelStatusEnum!
Example
{
  "avatarUrl": "abc123",
  "checkedAt": ISO8601DateTime,
  "displayName": "abc123",
  "handle": "abc123",
  "key": "abc123",
  "overrideMatchesBuffer": true,
  "source": "BUFFER",
  "status": "AMBIGUOUS"
}

MarketingSocialChannelSourceEnum

Description

Which source decides the Buffer channel for a social network.

Values
Enum Value Description

BUFFER

The connected account found by the Buffer sync.

NONE

No usable channel.

OVERRIDE

A fixed Buffer channel id is configured and wins.
Example
"BUFFER"

MarketingSocialChannelStatusEnum

Description

Whether a social channel can take drafts, per the last Buffer sync.

Values
Enum Value Description

AMBIGUOUS

More than one usable account; an admin must pick one.

CONNECTED

Exactly one usable account is connected.

DISCONNECTED

The account needs reconnecting in Buffer.

LOCKED

Buffer has locked the account.

MISSING

No account for this network in Buffer.

UNKNOWN

No Buffer sync has landed yet.
Example
"AMBIGUOUS"

MilestoneInput

Description

Input shape for a single milestone entry when creating or updating a goal template. Phase 83 consumes this.

Fields
Input Field Description
daysOffsetFromStart - Int! Number of days after goal start when this milestone is expected.
name - String! Display name of this milestone step.
order - Int! Zero-based position within the milestone sequence.
Example
{
  "daysOffsetFromStart": 987,
  "name": "xyz789",
  "order": 123
}

MintCheckInTokenPayload

Description

Autogenerated return type of MintCheckInToken.

Fields
Field Name Description
errors - [String!]!
expiresAt - ISO8601DateTime
token - String The raw check-in token — shown once, never persisted in plaintext.
Example
{
  "errors": ["xyz789"],
  "expiresAt": ISO8601DateTime,
  "token": "abc123"
}

ModelUsagePoint

Description

Per-model AI usage aggregation point for the admin dashboard.

Fields
Field Name Description
callCount - Int! Number of AI calls made with this model over the window.
costCents - Int! Sum of cost_cents over the window, rounded to the nearest cent.
model - String! Model identifier (e.g. gemini/gemini-3.8-flash).
tokenCount - Int! Sum of total_tokens over the window.
Example
{
  "callCount": 123,
  "costCents": 123,
  "model": "xyz789",
  "tokenCount": 987
}

MoodLog

Description

A daily mood check-in recorded by a user, optionally linked to a goal.

Fields
Field Name Description
createdAtTime - String! Unix timestamp (string) when this mood log was recorded.
goal - Goal Goal the user linked this mood entry to, if any.
mood - String! Mood value at time of check-in. One of: amazing, happy, calm, meh, tired, low.
note - String Optional free-text note (max 300 characters) describing how the user is feeling.
publicId - ID! URL-safe public identifier for this mood log entry.
Example
{
  "createdAtTime": "xyz789",
  "goal": Goal,
  "mood": "abc123",
  "note": "abc123",
  "publicId": "4"
}

NextBadge

Description

The locked badge closest to being unlocked for a user.

Fields
Field Name Description
key - String! Badge key matching the UserAction enum action name.
progressLabel - String! Human-readable progress label (e.g. "3/5 goals completed").
progressPercentage - Float! Completion percentage toward unlocking this badge (0–100).
Example
{
  "key": "abc123",
  "progressLabel": "abc123",
  "progressPercentage": 123.45
}

NotificationHistory

Description

Paginated notification history for the current user (acknowledged and unacknowledged).

Fields
Field Name Description
hasMore - Boolean! Whether there are more notifications beyond this page.
items - [UserNotification!]! Notifications for the current page, newest first.
totalCount - Int! Total number of notifications across all pages.
unreadCount - Int! Total unacknowledged notifications across all pages, for the same scope.
Example
{
  "hasMore": true,
  "items": [UserNotification],
  "totalCount": 987,
  "unreadCount": 987
}

OnboardingCompletedVia

Values
Enum Value Description

complete

User reached the final slide and finished the wizard.

skip

User exited the wizard before reaching the final slide.
Example
"complete"

OnboardingFunnel

Description

Aggregated onboarding funnel counts and time-to-first-goal percentiles. Admin only. Returns aggregates only — no user identifiers.

Fields
Field Name Description
firstGoal - Int! Distinct in-window users who have at least one non-deleted goal.
signedIn - Int! Distinct users with a first_sign_in UserAction in the window.
ttfgP50Seconds - Int Median seconds from sign-up to first goal. Null when no in-window user has created a goal.
ttfgP90Seconds - Int 90th-percentile time-to-first-goal in seconds. Nullable.
variantId - String Echoes the variant filter when one was applied; null for unfiltered queries.
wizardCompleted - Int! Distinct users with a wizard_completed UserAction in the window.
wizardStarted - Int! Distinct users with a wizard_started UserAction in the window.
Example
{
  "firstGoal": 123,
  "signedIn": 987,
  "ttfgP50Seconds": 123,
  "ttfgP90Seconds": 987,
  "variantId": "abc123",
  "wizardCompleted": 987,
  "wizardStarted": 123
}

OnboardingProgress

Description

In-flight progress through the onboarding wizard. Cleared (null) on exit.

Fields
Field Name Description
answers - JSON Free-form per-slide answers. Shape refined in Phase 34.
currentSlide - String Slide id the user is currently on.
updatedAt - ISO8601DateTime When progress was last written.
Example
{
  "answers": {},
  "currentSlide": "abc123",
  "updatedAt": ISO8601DateTime
}

OnboardingProgressInput

Fields
Input Field Description
answers - JSON Per-slide answers collected so far.
currentSlide - String! Slide id the user is currently on.
Example
{"answers": {}, "currentSlide": "xyz789"}

OnboardingStatus

Description

v1.8 onboarding completion status, sourced from UserDetail.data["onboarding"].

Fields
Field Name Description
completedAt - ISO8601DateTime When the user finished or was backfilled. null if in-flight.
completedVia - String How completion happened: "complete" | "skip" | "backfilled".
progress - OnboardingProgress In-flight slide progress. null after completion.
version - String Onboarding schema version: "v1.8" (flow-completed) or "pre-v1.8" (lazy-backfilled).
Example
{
  "completedAt": ISO8601DateTime,
  "completedVia": "abc123",
  "progress": OnboardingProgress,
  "version": "abc123"
}

OptIntoCollectiveGoalPayload

Description

Autogenerated return type of OptIntoCollectiveGoal.

Fields
Field Name Description
collectiveGoal - CollectiveGoal
errors - [String!]!
Example
{
  "collectiveGoal": CollectiveGoal,
  "errors": ["abc123"]
}

OptOutOfCollectiveGoalPayload

Description

Autogenerated return type of OptOutOfCollectiveGoal.

Fields
Field Name Description
collectiveGoal - CollectiveGoal
errors - [String!]!
Example
{
  "collectiveGoal": CollectiveGoal,
  "errors": ["xyz789"]
}

PaceSuggestion

Description

A one-tap timeline-adjustment suggestion for a goal that is consistently ahead of or behind pace.

Fields
Field Name Description
currentTargetDate - String! ISO date string of the goal's current target date.
direction - String! "ahead" or "behind" — drives icon and copy branch.
goalName - String! Display name of the goal, for body + confirmation copy.
goalPublicId - String! public_id of the goal this suggestion targets.
id - String! Stable ID for client-side dismissal state tracking.
paceSummary - String! Human phrase, e.g. "about 3 weeks faster than planned".
proposedTargetDate - String! ISO date string of the computed new target date.
Example
{
  "currentTargetDate": "xyz789",
  "direction": "abc123",
  "goalName": "xyz789",
  "goalPublicId": "abc123",
  "id": "xyz789",
  "paceSummary": "xyz789",
  "proposedTargetDate": "xyz789"
}

Pact

Description

A small cooperative challenge among 2-8 allies, built from a shared engine (D1).

Fields
Field Name Description
boardMembers - [PactBoardMember!]!
coachNote - String D20.4: the weekly Coach note, the first matching UI-SPEC template over the previous Pact week. Null before week 1 ends and for non-active Pacts. Never names a member.
createdAtTime - String!
creator - User
dayNumber - Int!
daysPerWeek - Int
endsOn - ISO8601Date Δ — derived from starts_on + length_days.
finalizedAt - ISO8601DateTime D21.4 — set by FinalizePact; null while the Pact is active or forming. Drives the 7-day Allies drop-off.
graceDays - Int!
lengthDays - Int!
missPolicy - String!
name - String!
nextWaypoint - Float Computed server-side per the UI-SPEC "Waypoints" rule, no column.
pactMemberships - [PactMembership!]!
pactRules - [PactRule!]! Live rules in position order, plus any rule removed since the viewer's last re-confirm (D17 gap 3).
publicId - ID!
restartBannerVisible - Boolean! Viewer-relative (D17 gap 4): the viewer's restart_seen_on is stale against last_restarted_on.
shape - String!
sharedTotal - Float One-total Pacts only (D18.5); null for every other shape.
stakes - String D13 — visible to joined members and open invite holders only; null otherwise (declined/expired invitees, non-members).
startsOn - ISO8601Date!
status - String!
takeoverEligible - Boolean! Viewer-relative (D10, D20.1): true when the viewer's own membership is credited on the current period's decided day (the viewer's local today, or the current Pact week for each-week Pacts) and acknowledgePactTakeover has not been called for it.
templateKey - String
timezone - String!
todayDecided - Boolean! Whether a PactDay row exists for the current date/week.
togetherDays - Int!
totalTarget - Float
totalUnit - String
updatedAtTime - String!
viewerMembership - PactMembership
visibility - String!
Example
{
  "boardMembers": [PactBoardMember],
  "coachNote": "xyz789",
  "createdAtTime": "xyz789",
  "creator": User,
  "dayNumber": 123,
  "daysPerWeek": 987,
  "endsOn": ISO8601Date,
  "finalizedAt": ISO8601DateTime,
  "graceDays": 123,
  "lengthDays": 987,
  "missPolicy": "abc123",
  "name": "xyz789",
  "nextWaypoint": 987.65,
  "pactMemberships": [PactMembership],
  "pactRules": [PactRule],
  "publicId": 4,
  "restartBannerVisible": true,
  "shape": "xyz789",
  "sharedTotal": 123.45,
  "stakes": "xyz789",
  "startsOn": ISO8601Date,
  "status": "xyz789",
  "takeoverEligible": false,
  "templateKey": "abc123",
  "timezone": "xyz789",
  "todayDecided": true,
  "togetherDays": 987,
  "totalTarget": 987.65,
  "totalUnit": "abc123",
  "updatedAtTime": "xyz789",
  "viewerMembership": PactMembership,
  "visibility": "abc123"
}

PactBoardMember

Description

One member's board row (Task 3b, OBJ-6353). rule_states is null for a co-member under done_only visibility (D13) — only today_complete is exposed then.

Fields
Field Name Description
daysDone - Int!
graceDaysLeft - Int
membership - PactMembership!
nudgedByViewerToday - Boolean! Viewer-relative (D20.2): true when the viewer already nudged this member in this Pact on the viewer's local day. Always false on the viewer's own row.
ruleStates - [PactBoardRuleState!]
steppedOut - Boolean!
todayComplete - Boolean!
Example
{
  "daysDone": 987,
  "graceDaysLeft": 123,
  "membership": PactMembership,
  "nudgedByViewerToday": true,
  "ruleStates": [PactBoardRuleState],
  "steppedOut": false,
  "todayComplete": true
}

PactBoardRuleState

Description

One rule's state for a board member on today's local date (Task 3b, OBJ-6353).

Fields
Field Name Description
amount - Float
note - String
photoUrl - String
rule - PactRule!
state - String! 'done' / 'open' / 'not_due'.
synced - Boolean v4.129 (GQL-08) — owner-only: true/false for this row's own member, null for a co-member.
Example
{
  "amount": 123.45,
  "note": "xyz789",
  "photoUrl": "abc123",
  "rule": PactRule,
  "state": "abc123",
  "synced": false
}

PactMembership

Description

One member's seat in a Pact, including an open invite.

Fields
Field Name Description
blocked - Boolean! D20.5: the viewer's own open invite can't be joined because of a block between the viewer and a joined member (either direction). Always false on anyone else's membership, so it never reveals a block between other people.
celebrationSeen - Boolean! D21.2 — viewer-only: always false on another member's row (the #blocked precedent), so it never reveals whether someone else has opened the Finish screen. Drives the one-time routing to it.
celebrationSeenAt - ISO8601DateTime
completedAt - ISO8601DateTime
daysDone - Int! D21 Finish/Ended recap — the existing days_done column, exposed directly (no board-member wrapper needed for a single-Pact detail read).
expired - Boolean! An open invite past the end of Pact day 3 (D8).
joinedOn - ISO8601Date
linkedGoal - Goal
needsReconfirm - Boolean!
oneTotalAmount - Float! D21 Finish/Ended recap — this member's share of a one_total Pact shared total (Δ, sum of pact_ticks.amount). Meaningless (but present) off a one_total Pact.
pact - Pact!
publicId - ID!
role - String!
status - String!
steppedOutAt - ISO8601DateTime
user - User!
Example
{
  "blocked": true,
  "celebrationSeen": true,
  "celebrationSeenAt": ISO8601DateTime,
  "completedAt": ISO8601DateTime,
  "daysDone": 987,
  "expired": true,
  "joinedOn": ISO8601Date,
  "linkedGoal": Goal,
  "needsReconfirm": true,
  "oneTotalAmount": 123.45,
  "pact": Pact,
  "publicId": 4,
  "role": "xyz789",
  "status": "abc123",
  "steppedOutAt": ISO8601DateTime,
  "user": User
}

PactRule

Description

One of a Pact's 1-6 rules.

Fields
Field Name Description
cadence - String!
cadenceDays - [String!]
cadenceTimesPerWeek - Int
changeState - String Relative to the viewer's own terms_confirmed_at (D17 gap 3): "new", "changed", "removed", or null when nothing changed or the viewer has no membership to compare against.
detail - String
estMinutes - Int
iconKey - String!
kind - String!
label - String!
mySync - PactRuleMySync v4.129 (S7) — the viewer's own sync state for this rule. Null when the viewer has no membership in this Pact.
position - Int!
proof - String!
publicId - ID!
shortLabel - String!
syncEligible - Boolean! v4.129 (S3) — true when this rule can be opted into Strava sync (hit_number, proof none, a unit that maps onto a metric).
targetAmount - Float
unit - String
weeklyIncrease - Float
Example
{
  "cadence": "xyz789",
  "cadenceDays": ["abc123"],
  "cadenceTimesPerWeek": 123,
  "changeState": "abc123",
  "detail": "abc123",
  "estMinutes": 987,
  "iconKey": "abc123",
  "kind": "abc123",
  "label": "abc123",
  "mySync": PactRuleMySync,
  "position": 987,
  "proof": "xyz789",
  "publicId": 4,
  "shortLabel": "abc123",
  "syncEligible": false,
  "targetAmount": 987.65,
  "unit": "xyz789",
  "weeklyIncrease": 987.65
}

PactRuleInput

Fields
Input Field Description
cadence - String!
cadenceDays - [String!]
cadenceTimesPerWeek - Int
detail - String
estMinutes - Int
iconKey - String
kind - String!
label - String!
proof - String
publicId - ID
shortLabel - String
targetAmount - Float
unit - String
weeklyIncrease - Float
Example
{
  "cadence": "abc123",
  "cadenceDays": ["abc123"],
  "cadenceTimesPerWeek": 987,
  "detail": "xyz789",
  "estMinutes": 123,
  "iconKey": "abc123",
  "kind": "xyz789",
  "label": "xyz789",
  "proof": "abc123",
  "publicId": 4,
  "shortLabel": "xyz789",
  "targetAmount": 987.65,
  "unit": "xyz789",
  "weeklyIncrease": 987.65
}

PactRuleMySync

Description

GQL-06 — the viewer's own Strava sync state for one Pact rule. Resolves only for the viewer's own membership (PactRuleType#my_sync returns null otherwise).

Fields
Field Name Description
connectionStatus - String! 'NONE' / 'ACTIVE' / 'PAUSED' / 'ERROR'.
lastSkip - PactRuleSyncSkip
linked - Boolean!
providerActivityType - String
syncedToday - Boolean!
todaySyncedAmount - Float Rule unit, 1 decimal place, null when 0 (nothing synced yet today).
todayTarget - Float
Example
{
  "connectionStatus": "abc123",
  "lastSkip": PactRuleSyncSkip,
  "linked": true,
  "providerActivityType": "abc123",
  "syncedToday": true,
  "todaySyncedAmount": 123.45,
  "todayTarget": 987.65
}

PactRuleSyncSkip

Description

GQL-07 — the most recent skipped Strava activity for a synced Pact rule link.

Fields
Field Name Description
activityDate - ISO8601Date!
amount - Float
reason - String! 'DAY_CLOSED' or 'BEFORE_LINK'.
unit - String
Example
{
  "activityDate": ISO8601Date,
  "amount": 123.45,
  "reason": "abc123",
  "unit": "abc123"
}

PactSizeEstimate

Fields
Field Name Description
minutes - Float!
ruleCount - Int!
warnMinutes - Boolean!
warnRules - Boolean!
Example
{"minutes": 123.45, "ruleCount": 123, "warnMinutes": true, "warnRules": true}

PactTemplate

Fields
Field Name Description
daysPerWeek - Int
graceDays - Int!
key - String!
lengthDays - Int!
missPolicy - String!
name - String!
rules - [PactTemplateRule!]!
shape - String!
sizeEstimate - PactSizeEstimate! The Coach size check for this template as-is (D17 gap 8).
totalTarget - Float
totalUnit - String
visibility - String!
Example
{
  "daysPerWeek": 987,
  "graceDays": 123,
  "key": "abc123",
  "lengthDays": 123,
  "missPolicy": "xyz789",
  "name": "abc123",
  "rules": [PactTemplateRule],
  "shape": "xyz789",
  "sizeEstimate": PactSizeEstimate,
  "totalTarget": 123.45,
  "totalUnit": "abc123",
  "visibility": "abc123"
}

PactTemplateRule

Fields
Field Name Description
cadence - String!
cadenceDays - [String!]
cadenceTimesPerWeek - Int
detail - String
estMinutes - Int
iconKey - String!
kind - String!
label - String!
proof - String!
shortLabel - String!
targetAmount - Float
unit - String
weeklyIncrease - Float
Example
{
  "cadence": "abc123",
  "cadenceDays": ["xyz789"],
  "cadenceTimesPerWeek": 987,
  "detail": "abc123",
  "estMinutes": 123,
  "iconKey": "xyz789",
  "kind": "xyz789",
  "label": "xyz789",
  "proof": "abc123",
  "shortLabel": "xyz789",
  "targetAmount": 123.45,
  "unit": "xyz789",
  "weeklyIncrease": 987.65
}

PactTick

Description

One member's completion of one rule on one member-local date.

Fields
Field Name Description
amount - Float
note - String
publicId - ID!
sharedWithPact - Boolean!
synced - Boolean v4.129 (S7) — owner-only: true/false for the tick's own owner, null for anyone else.
Example
{
  "amount": 123.45,
  "note": "abc123",
  "publicId": 4,
  "sharedWithPact": true,
  "synced": true
}

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
endCursor - String When paginating forwards, the cursor to continue.
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
Example
{
  "endCursor": "xyz789",
  "hasNextPage": false,
  "hasPreviousPage": true,
  "startCursor": "abc123"
}

ParkGoalIdeasPayload

Description

Autogenerated return type of ParkGoalIdeas.

Fields
Field Name Description
errors - [String!]!
goalIdeas - [GoalIdea!]!
success - Boolean!
Example
{
  "errors": ["xyz789"],
  "goalIdeas": [GoalIdea],
  "success": false
}

ParseChallengePayload

Description

Autogenerated return type of ParseChallenge.

Fields
Field Name Description
aiRequest - AiRequest The AiRequest tracking this call, resolved by Ai::DispatchAiRequestJob (v4.60). Subscribe to aiRequestUpdate(requestId: id) or poll aiRequest(id:) for the parsed draft.
Example
{"aiRequest": AiRequest}

PartnerActivityGoal

Description

The goal a partner recent-activity item belongs to (DATA-02, v4.116).

Fields
Field Name Description
publicId - ID! URL-safe public identifier of the goal.
title - String! The goal's name.
Example
{
  "publicId": "4",
  "title": "abc123"
}

PartnerActivityItem

Description

A single check-in or milestone hit from AccountabilityPartnerType#recentActivity (DATA-02, v4.116).

Fields
Field Name Description
goal - PartnerActivityGoal! The goal this activity item belongs to.
goalEventPublicId - ID public_id of the underlying check-in event. Null for a milestone hit.
kind - PartnerActivityKindEnum! Whether this item is a check-in or a milestone hit.
occurredAt - ISO8601DateTime! When the check-in or milestone completion happened.
viewerEncouraged - Boolean! Whether the viewer has already cheered this specific check-in or milestone.
Example
{
  "goal": PartnerActivityGoal,
  "goalEventPublicId": 4,
  "kind": "CHECK_IN",
  "occurredAt": ISO8601DateTime,
  "viewerEncouraged": false
}

PartnerActivityKindEnum

Description

Discriminator for which branch a partner recent-activity item represents (DATA-02, v4.116).

Values
Enum Value Description

CHECK_IN

A check-in (goal event) on a partner-visible goal.

MILESTONE

A completed milestone on a partner-visible goal.
Example
"CHECK_IN"

PauseAiAutopilotPayload

Description

Autogenerated return type of PauseAiAutopilot.

Fields
Field Name Description
autopilot - AiAutopilot
errors - [String!]!
Example
{
  "autopilot": AiAutopilot,
  "errors": ["xyz789"]
}

PauseAiEmployeePayload

Description

Autogenerated return type of PauseAiEmployee.

Fields
Field Name Description
employee - AiEmployee
errors - [String!]!
Example
{
  "employee": AiEmployee,
  "errors": ["xyz789"]
}

PauseIntegrationConnectionPayload

Description

Autogenerated return type of PauseIntegrationConnection.

Fields
Field Name Description
errors - [String!]!
integrationConnection - IntegrationConnection
Example
{
  "errors": ["abc123"],
  "integrationConnection": IntegrationConnection
}

PendingAllyUser

Description

The requesting user for a pending ally request.

Fields
Field Name Description
firstName - String The requesting user's given name.
lastName - String The requesting user's family name.
photo - UserPhoto The requesting user's profile photo.
publicId - String The requesting user's URL-safe public identifier.
username - String The requesting user's unique handle.
Example
{
  "firstName": "abc123",
  "lastName": "abc123",
  "photo": UserPhoto,
  "publicId": "xyz789",
  "username": "abc123"
}

PendingCounts

Description

Per-queue pending item counts for the admin sidebar. Fields return nil when the current user lacks the role to see that queue (UI hides the badge — never renders 0 for an inaccessible queue).

Fields
Field Name Description
gdprRequests - Int GDPR requests in received state. Nil if the current role cannot handle GDPR requests. Returns 0 until Phase 28 creates the table.
marketingDecisions - Int Marketing posts and emails waiting on a decision. Clears when the work is done. Nil if the current role cannot review marketing work.
moderationQueue - Int Pending content flags awaiting moderator review. Nil if the current role cannot moderate.
reviewQueue - Int AI artifacts awaiting admin approval. Nil if the current role cannot approve artifacts.
workforceDecisions - Int Pending AI Workforce artifacts across every crew the viewer can see (all crews for super admins, marketing only for marketing users), shadow, paused and archived agents included, matching the Review tab. Nil if the current role cannot review AI Workforce work.
workforceInbox - Int Unarchived, unresolved, actionable AI Workforce inbox items for the viewer. Nil if the current role cannot see the AI Workforce inbox.
Example
{
  "gdprRequests": 123,
  "marketingDecisions": 987,
  "moderationQueue": 123,
  "reviewQueue": 123,
  "workforceDecisions": 123,
  "workforceInbox": 123
}

Plan

Description

A subscription plan (Supporter Monthly, Yearly, or Lifetime).

Fields
Field Name Description
active - Boolean! Whether the plan is available for purchase.
currency - String! ISO currency code (default: usd).
interval - String Billing interval (month, year, or null for one-time).
name - String! Display name (e.g. "Supporter Monthly").
priceCents - Int! Price in cents (e.g. 400 = $4.00).
priceDisplay - String! Formatted price string (e.g. "$4.00/month").
publicId - ID! URL-safe public identifier for the plan.
slug - String! URL-safe slug (monthly, yearly, lifetime).
Example
{
  "active": false,
  "currency": "xyz789",
  "interval": "abc123",
  "name": "xyz789",
  "priceCents": 987,
  "priceDisplay": "xyz789",
  "publicId": 4,
  "slug": "xyz789"
}

PostComment

Description

A comment left on a community post.

Fields
Field Name Description
content - String! Text body of the comment.
id - ID! Public identifier for this comment.
timestamp - String! Unix timestamp (string) when the comment was posted.
userId - ID! public_id of the user who wrote the comment.
userName - String! Username of the comment author.
Example
{
  "content": "xyz789",
  "id": 4,
  "timestamp": "xyz789",
  "userId": 4,
  "userName": "abc123"
}

PostPerformance

Description

How an agent's sent social posts performed, summarised from Buffer metrics. A metric Buffer did not report is absent, never zero.

Fields
Field Name Description
channels - [ChannelAverage!]! Per-channel averages of reported metrics.
measuredAt - ISO8601DateTime
postsMeasured - Int!
topPosts - [TopPost!]!
windowDays - Int!
Example
{
  "channels": [ChannelAverage],
  "measuredAt": ISO8601DateTime,
  "postsMeasured": 123,
  "topPosts": [TopPost],
  "windowDays": 987
}

PracticeCadenceEnum

Description

How often a practice (a habit linked to a long goal) repeats. Mapped to Goal recurrence attributes anchored on today, in the user's timezone (see GoalTracking::PracticeCadence).

Values
Enum Value Description

DAILY

Every day.

THREE_PER_WEEK

Three days a week, whichever days suit. Alias for TIMES_PER_WEEK with a target of 3. Use TIMES_PER_WEEK with habitWeeklyTarget 3 instead (D6, OBJ-5726).

TIMES_PER_WEEK

Any N days a week, whichever days suit (N = habitWeeklyTarget, 1-6, default 3); the week is met once N check-ins land.

WEEKLY

Once a week, on today's weekday.
Example
"DAILY"

PracticeInput

Description

A practice to create: alongside a long goal in CompleteOnboardingAndCreateGoal, or linked to an existing one via AddPractice (v4.93 Phase 4, OBJ-5448).

Fields
Input Field Description
cadence - PracticeCadenceEnum! How often the practice repeats.
habitWeeklyTarget - Int Times per week when cadence is TIMES_PER_WEEK: 1-6, defaults to 3. Ignored for every other cadence.
name - String! Display name of the practice (max 50 chars).
Example
{
  "cadence": "DAILY",
  "habitWeeklyTarget": 123,
  "name": "xyz789"
}

PracticeWeek

Description

A goal's completions and planned slots for the current Monday-start week, in the owner's timezone (OBJ-5452).

Fields
Field Name Description
completedDates - [ISO8601Date!]! Dates with a check-in in the current week.
plannedSlots - Int! This cadence's scheduled days within the current week.
Example
{"completedDates": [ISO8601Date], "plannedSlots": 987}

ProgressDataPoint

Description

A single data point in a progress chart.

Fields
Field Name Description
count - Int! Number of events logged in this period.
date - String! ISO date string for the start of this period.
label - String! Display label for this period (e.g. "Mar 15" or "Mar 15 - Mar 21").
Example
{
  "count": 123,
  "date": "xyz789",
  "label": "xyz789"
}

PromoteTeamMemberPayload

Description

Autogenerated return type of PromoteTeamMember.

Fields
Field Name Description
errors - [String!]!
teamMembership - TeamMembership
Example
{
  "errors": ["xyz789"],
  "teamMembership": TeamMembership
}

PromotionCriteria

Fields
Field Name Description
approvalRatePct - Int!
blockReason - String
byKind - [PromotionKindCriteria!]!
canPromoteTo - String
promotionConfirmedAt - ISO8601DateTime
recentRejections - Int!
shadowLocked - Boolean! True iff the role is in AiEmployee::SHADOW_LOCKED_ROLES. Doesn't depend on sample size, unlike canPromoteTo.
weeksActive - Int!
Example
{
  "approvalRatePct": 123,
  "blockReason": "xyz789",
  "byKind": [PromotionKindCriteria],
  "canPromoteTo": "xyz789",
  "promotionConfirmedAt": ISO8601DateTime,
  "recentRejections": 987,
  "shadowLocked": false,
  "weeksActive": 987
}

PromotionKindCriteria

Description

Promotion standing for one (agent, output kind) pair (OBJ-5771, v4.98 Phase 9).

Fields
Field Name Description
approvalRate - Float approved / decided, like AiEmployeeStatsType#approvalRate. Null when decided is 0.
approvedAfterRevision - Int! Of the approvals above, how many landed after at least one revision. Informational only — a revision chain already counts once, by its final decision.
autonomyLevel - String!
blockReason - String
canPromoteTo - String
confirmedAt - ISO8601DateTime
confirmedByName - String
decided - Int! Decided outputs of this kind in the window below.
kind - String!
windowWeeks - Int!
Example
{
  "approvalRate": 123.45,
  "approvedAfterRevision": 123,
  "autonomyLevel": "xyz789",
  "blockReason": "xyz789",
  "canPromoteTo": "abc123",
  "confirmedAt": ISO8601DateTime,
  "confirmedByName": "abc123",
  "decided": 987,
  "kind": "abc123",
  "windowWeeks": 123
}

ProviderCount

Description

A provider's share of a day or week's automatic check-ins (OBJ-6493 Task 2).

Fields
Field Name Description
count - Int! How many check-ins this provider created in this scope.
providerName - String! Display name, e.g. "Strava".
providerSlug - String! e.g. "strava", "chess_com".
Example
{
  "count": 987,
  "providerName": "abc123",
  "providerSlug": "abc123"
}

PublicCommunity

Description

The allow-listed public preview of a community: name, description, category and member-count-to-discoverable progress. No member identities, posts, feed or stats.

Fields
Field Name Description
category - String General category label for the community (e.g. "fitness").
description - String Human-readable description of the community purpose.
imageUrl - String URL of the community avatar/icon image.
membersCount - Int! Total number of members in this community.
membersToDiscoverable - Int! Members still needed to appear in discovery (0 when discoverable).
name - String! Display name of the community.
publicId - ID! URL-safe public identifier for this community.
Example
{
  "category": "xyz789",
  "description": "xyz789",
  "imageUrl": "xyz789",
  "membersCount": 123,
  "membersToDiscoverable": 123,
  "name": "abc123",
  "publicId": 4
}

PublicFeedbackAuthor

Description

Public-safe author identity for the anonymous feedback read path. Allow-listed by design — structurally cannot reach Types::UserType.

Fields
Field Name Description
avatarUrl - String Profile photo URL, or null for a private_mode author and for an author with no uploaded photo — the two are indistinguishable.
displayName - String! Resolves to "{FirstName} {LastInitial}." (e.g. "Priya S.") for a normal author, or the literal "a member" for a private_mode author and for an author with no renderable name — the two are byte-identical so this field never discloses who has private mode on.
Example
{
  "avatarUrl": "xyz789",
  "displayName": "abc123"
}

PublicFeedbackComment

Description

A comment on a feedback post, on the anonymous public read path.

Fields
Field Name Description
author - PublicFeedbackAuthor! The author of this comment.
body - String! The comment text.
createdAt - ISO8601DateTime!
id - ID! Public identifier for this comment.
isOfficial - Boolean! Whether this is an official team response.
Example
{
  "author": PublicFeedbackAuthor,
  "body": "xyz789",
  "createdAt": ISO8601DateTime,
  "id": 4,
  "isOfficial": true
}

PublicFeedbackPost

Description

A user-submitted feedback post, on the anonymous public read path (v4.62 Phase 6). No votedByCurrentUser — it cannot be honestly answered for an anonymous caller, so it is not askable at all.

Fields
Field Name Description
author - PublicFeedbackAuthor! The author of this feedback post.
category - String! Category: feature, improvement, bug, or other.
commentCount - Int! Total number of comments.
comments - [PublicFeedbackComment!]! Comments on this post.
createdAt - ISO8601DateTime!
description - String Detailed description of the feedback.
id - ID! Public identifier for this feedback post.
shippedAt - ISO8601DateTime When this post was marked as completed/shipped.
status - String! Status: open, planned, in_progress, completed, or declined.
tags - [FeedbackTag!]! Tags attached to this post.
title - String! Title of the feedback post.
voteCount - Int! Total number of votes.
Example
{
  "author": PublicFeedbackAuthor,
  "category": "xyz789",
  "commentCount": 123,
  "comments": [PublicFeedbackComment],
  "createdAt": ISO8601DateTime,
  "description": "abc123",
  "id": 4,
  "shippedAt": ISO8601DateTime,
  "status": "xyz789",
  "tags": [FeedbackTag],
  "title": "xyz789",
  "voteCount": 123
}

PublicGoal

Description

A goal visible on a public profile. Exposes only the fields safe for any authenticated viewer — no user back-reference.

Fields
Field Name Description
category - GoalCategory Goal category (e.g. fitness, learning).
completed - Boolean! Whether the goal has been marked as completed.
createdAtTime - String Unix timestamp (string) when the goal was created.
currentAmount - Float Current progress value for quantity-based goals.
habitStreak - Int! Current consecutive check-in streak for this habit.
habitStreakUnit - HabitStreakUnitEnum! Unit habit_streak/longest_habit_streak are counted in: DAY, or WEEK for times_per_week.
imageUrl - String URL of a cover image associated with the goal.
kind - GoalType The goal kind/type (e.g. habit, milestone, quantity).
longestHabitStreak - Int! All-time longest streak for this habit.
milestonesCount - Int! Total number of milestones (sub-goals) under this goal.
name - String! Display name of the goal.
publicId - ID! URL-safe public identifier for this goal.
recurrenceDays - [String!] Days of the week for weekly/custom_days recurrence (e.g. ["mon", "wed", "fri"]).
recurrenceType - String Recurrence pattern: daily, weekly, custom_days, times_per_week, or interval. Null for non-habit goals.
targetAmount - Float Target value for quantity-based goals.
targetDateTime - String Unix timestamp (string) of the target completion date.
viewerCheeredToday - Boolean Whether the viewer has sent a goal-scoped cheer (encourage with this goalId) today. Null for a logged-out viewer.
weeklyTarget - Int Check-ins per Monday-start week for a times_per_week habit (1-6); the week is met once this many land, on any days. Null for every other recurrence type.
Example
{
  "category": GoalCategory,
  "completed": false,
  "createdAtTime": "xyz789",
  "currentAmount": 987.65,
  "habitStreak": 987,
  "habitStreakUnit": "DAY",
  "imageUrl": "xyz789",
  "kind": GoalType,
  "longestHabitStreak": 987,
  "milestonesCount": 123,
  "name": "abc123",
  "publicId": 4,
  "recurrenceDays": ["abc123"],
  "recurrenceType": "xyz789",
  "targetAmount": 987.65,
  "targetDateTime": "abc123",
  "viewerCheeredToday": false,
  "weeklyTarget": 987
}

PublicProfile

Description

Publicly visible profile of a user. Only exposes fields safe for anyone to see.

Fields
Field Name Description
achievementStats - AchievementStats Computed rank, XP, and badge stats for the profile hero.
alliesCount - Int! Number of accepted allies (either direction).
allyGoals - [PublicGoal!]! Owner's active allies-only goals (visibility: allies), not already included in publicGoals. Only populated when the viewer is an accepted ally of the owner; empty otherwise (including for self).
allyStatus - String Viewer-relative ally relationship to this profile (NONE / PENDING_OUTGOING / PENDING_INCOMING / ACCEPTED / BLOCKED / SELF). Null for anonymous viewers. SELF when the viewer is the profile owner.
canEncourage - Boolean! Whether an encouragement from the viewer would have a goal to land on: the owner has a goal the viewer can see, and neither has blocked the other. False for self. For a logged-out viewer, whether a public goal exists.
firstName - String The user's given name.
goItAlone - Boolean! Whether the owner has solo mode on. True only when the owner has solo mode on and the viewer is an accepted ally; false otherwise (anonymous viewers, non-allies, pending allies, and self).
lastName - String The user's family name.
level - Int! Current gamification level derived from XP.
longestStreak - Int! All-time longest streak of consecutive active days.
nextLevelThreshold - Int! XP required to reach the next level.
nextOnTheShelfBadge - NextBadge The locked badge closest to being unlocked, or null if all earned.
partnerGoals - [PublicGoal!]! Owner's active partner-visible goals (public goals, plus private goals the owner opted to share via shared_with_partner). Only populated when the viewer is a confirmed active accountability partner of the owner; empty otherwise (including for self).
photo - UserPhoto Profile photo for the user.
progressToNextLevel - Float! Progress toward the next level.
publicGoals - [PublicGoal!]! Non-private active goals belonging to this user.
publicId - ID! Public-safe opaque identifier for this user (base64 token, never the integer PK).
showcasedAchievements - [String!]! Achievement identifiers the user has chosen to display on their profile.
signInDates - [String!] ISO date strings on which the user logged activity (heatmap source).
signupAgeDays - Int! Whole days since the user account was created (signup age).
streak - Int! Current number of consecutive days the user has logged activity.
unlockedBadges - [RecentlyUnlockedBadge!]! Earned badges, rarity DESC then unlocked_at DESC.
username - String! The user's unique handle (e.g. "jane.doe").
viewerCheeredToday - Boolean Whether the viewer has encouraged any of this user's goals today (any form — event-level or goal-level). Null for a logged-out viewer.
viewerIsAccountabilityPartner - Boolean! Whether the viewer is a confirmed active accountability partner of this profile owner. False for anonymous viewers, non-partners, blocked relationships, and self.
xp - Int! Total experience points earned through goals, events, and engagement.
Example
{
  "achievementStats": AchievementStats,
  "alliesCount": 123,
  "allyGoals": [PublicGoal],
  "allyStatus": "abc123",
  "canEncourage": true,
  "firstName": "abc123",
  "goItAlone": false,
  "lastName": "abc123",
  "level": 987,
  "longestStreak": 987,
  "nextLevelThreshold": 987,
  "nextOnTheShelfBadge": NextBadge,
  "partnerGoals": [PublicGoal],
  "photo": UserPhoto,
  "progressToNextLevel": 987.65,
  "publicGoals": [PublicGoal],
  "publicId": 4,
  "showcasedAchievements": ["xyz789"],
  "signInDates": ["xyz789"],
  "signupAgeDays": 123,
  "streak": 987,
  "unlockedBadges": [RecentlyUnlockedBadge],
  "username": "abc123",
  "viewerCheeredToday": false,
  "viewerIsAccountabilityPartner": false,
  "xp": 987
}

ReassignAiAssignmentPayload

Description

Autogenerated return type of ReassignAiAssignment.

Fields
Field Name Description
assignment - AiAssignment
errors - [String!]!
Example
{
  "assignment": AiAssignment,
  "errors": ["abc123"]
}

RecentlyUnlockedBadge

Description

A badge recently unlocked by the user.

Fields
Field Name Description
community - BadgeSourceCommunity The community a founding_member badge was earned in, when the viewer may see it (public community, a member, or the owner). Null otherwise.
key - String! Badge key matching the UserAction enum action name.
source - BadgeSource Where this badge came from, when a source was recorded for it and the viewer may see it. Null means no source, or not visible.
unlockedAt - ISO8601DateTime! When the badge was unlocked.
Example
{
  "community": BadgeSourceCommunity,
  "key": "xyz789",
  "source": BadgeSource,
  "unlockedAt": ISO8601DateTime
}

ReconfirmPactTermsPayload

Description

Autogenerated return type of ReconfirmPactTerms.

Fields
Field Name Description
errors - [String!]!
pact - Pact
pactMembership - PactMembership
Example
{
  "errors": ["abc123"],
  "pact": Pact,
  "pactMembership": PactMembership
}

RecordCriticalPathPlayPayload

Description

Autogenerated return type of RecordCriticalPathPlay.

Fields
Field Name Description
errors - [String!]!
status - CriticalPathPlayStatus
stimXpEarned - Int Stim XP delta awarded this play; null on duplicate or inactive feature.
Example
{
  "errors": ["abc123"],
  "status": CriticalPathPlayStatus,
  "stimXpEarned": 123
}

RecordSharePayload

Description

Autogenerated return type of RecordShare.

Fields
Field Name Description
errors - [String!]!
shareEvent - ShareEvent
Example
{
  "errors": ["abc123"],
  "shareEvent": ShareEvent
}

RecordUserActionPayload

Description

Autogenerated return type of RecordUserAction.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

RefineDescriptionPayload

Description

Autogenerated return type of RefineDescription.

Fields
Field Name Description
aiRequest - AiRequest The AiRequest tracking this call, resolved by Ai::DispatchAiRequestJob (v4.60). Subscribe to aiRequestUpdate(requestId: id) or poll aiRequest(id:) for the result. Null only on the fallback failure payload.
description - String
Example
{
  "aiRequest": AiRequest,
  "description": "xyz789"
}

RefineGoalPayload

Description

Autogenerated return type of RefineGoal.

Fields
Field Name Description
aiRequest - AiRequest The AiRequest tracking this call, resolved by Ai::DispatchAiRequestJob (v4.60). Subscribe to aiRequestUpdate(requestId: id) or poll aiRequest(id:) for the result. Null only on the fallback failure payload.
suggestions - [GoalRefinementSuggestion!]
Example
{
  "aiRequest": AiRequest,
  "suggestions": [GoalRefinementSuggestion]
}

RejectAiArtifactPayload

Description

Autogenerated return type of RejectAiArtifact.

Fields
Field Name Description
artifact - AiArtifact
errors - [String!]!
Example
{
  "artifact": AiArtifact,
  "errors": ["xyz789"]
}

ReminderNotificationPreferences

Description

Progress-nudge reminder notification preferences for the authenticated user.

Fields
Field Name Description
enabled - Boolean! Whether the user receives in-app and push notifications for stale/past-due goal, habit check-in, mood check-in, and partner missed-day nudges.
whyLineEnabled - Boolean! Whether the habit check-in reminder push may include the user's own-words or fallback why-line (OBJ-5644).
Example
{"enabled": false, "whyLineEnabled": false}

RemoveAllyPayload

Description

Autogenerated return type of RemoveAlly.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": false}

RemoveTeamMemberPayload

Description

Autogenerated return type of RemoveTeamMember.

Fields
Field Name Description
errors - [String!]!
teamMembership - TeamMembership
Example
{
  "errors": ["xyz789"],
  "teamMembership": TeamMembership
}

ReorderMilestonesPayload

Description

Autogenerated return type of ReorderMilestones.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

RepairStreakPayload

Description

Autogenerated return type of RepairStreak.

Fields
Field Name Description
errors - [String!]!
goal - Goal
user - User
Example
{
  "errors": ["xyz789"],
  "goal": Goal,
  "user": User
}

ReportContentPayload

Description

Autogenerated return type of ReportContent.

Fields
Field Name Description
contentReport - ContentReport
errors - [String!]
Example
{
  "contentReport": ContentReport,
  "errors": ["abc123"]
}

RequestAiArtifactChangesPayload

Description

Autogenerated return type of RequestAiArtifactChanges.

Fields
Field Name Description
artifact - AiArtifact
errors - [String!]!
run - AiRun The revision run that was queued.
Example
{
  "artifact": AiArtifact,
  "errors": ["abc123"],
  "run": AiRun
}

RequestAiChatTaskDraftPayload

Description

Autogenerated return type of RequestAiChatTaskDraft.

Fields
Field Name Description
errors - [String!]!
session - AiChatSession
Example
{
  "errors": ["abc123"],
  "session": AiChatSession
}

RequestDataExportPayload

Description

Autogenerated return type of RequestDataExport.

Fields
Field Name Description
errors - [String!]!
gdprRequest - GdprRequest
Example
{
  "errors": ["xyz789"],
  "gdprRequest": GdprRequest
}

RequestMagicCodePayload

Description

Autogenerated return type of RequestMagicCode.

Fields
Field Name Description
challenge - String!
errors - [String!]!
success - Boolean!
Example
{
  "challenge": "abc123",
  "errors": ["abc123"],
  "success": true
}

RerunHabitIntegrationMappingPayload

Description

Autogenerated return type of RerunHabitIntegrationMapping.

Fields
Field Name Description
errors - [String!]!
proposals - [MappingProposal!]
Example
{
  "errors": ["abc123"],
  "proposals": [MappingProposal]
}

ResetOnboardingPayload

Description

Autogenerated return type of ResetOnboarding.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
user - User
Example
{
  "errors": ["xyz789"],
  "success": false,
  "user": User
}

ResolvedModelUsagePoint

Description

Per-resolved-model AI usage aggregation point for the admin dashboard.

Fields
Field Name Description
callCount - Int! Number of AI calls made with this resolved model over the window.
costCents - Int! Sum of cost_cents over the window, rounded to the nearest cent.
resolvedModel - String! Concrete model id that served the request (e.g. gemini/gemini-2.5-flash).
tokenCount - Int! Sum of total_tokens over the window.
Example
{
  "callCount": 123,
  "costCents": 123,
  "resolvedModel": "xyz789",
  "tokenCount": 123
}

RespondToPactInvitePayload

Description

Autogenerated return type of RespondToPactInvite.

Fields
Field Name Description
errors - [String!]!
pact - Pact
pactMembership - PactMembership
Example
{
  "errors": ["xyz789"],
  "pact": Pact,
  "pactMembership": PactMembership
}

Result

Description

Generic boolean result returned by check queries (e.g. authn_check, is_following_goal).

Fields
Field Name Description
success - Boolean! True if the checked condition is satisfied.
Example
{"success": false}

ResumeAiAutopilotPayload

Description

Autogenerated return type of ResumeAiAutopilot.

Fields
Field Name Description
autopilot - AiAutopilot
errors - [String!]!
Example
{
  "autopilot": AiAutopilot,
  "errors": ["abc123"]
}

ResumeIntegrationConnectionPayload

Description

Autogenerated return type of ResumeIntegrationConnection.

Fields
Field Name Description
errors - [String!]!
integrationConnection - IntegrationConnection
Example
{
  "errors": ["xyz789"],
  "integrationConnection": IntegrationConnection
}

ResumeTeamSubscriptionPayload

Description

Autogenerated return type of ResumeTeamSubscription.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": true}

RetryAiArtifactDeliveryPayload

Description

Autogenerated return type of RetryAiArtifactDelivery.

Fields
Field Name Description
artifact - AiArtifact
errors - [String!]!
Example
{
  "artifact": AiArtifact,
  "errors": ["abc123"]
}

RetryAiArtifactPayload

Description

Autogenerated return type of RetryAiArtifact.

Fields
Field Name Description
artifact - AiArtifact
errors - [String!]!
run - AiRun The retry run that was queued.
Example
{
  "artifact": AiArtifact,
  "errors": ["abc123"],
  "run": AiRun
}

RetryAiChatMessagePayload

Description

Autogenerated return type of RetryAiChatMessage.

Fields
Field Name Description
errors - [String!]!
message - AiChatMessage
Example
{
  "errors": ["xyz789"],
  "message": AiChatMessage
}

RetryAiRunPayload

Description

Autogenerated return type of RetryAiRun.

Fields
Field Name Description
errors - [String!]!
run - AiRun
Example
{
  "errors": ["abc123"],
  "run": AiRun
}

ReverseNudge

Description

A one-time reverse-nudge for a habit-only user, naming the eligible habit for the "What's this building toward?" Dashboard card.

Fields
Field Name Description
completions - Int! Total habit_completions count for this habit.
daysSinceCreated - Int! Whole days since the habit was created, in the user's timezone.
habitId - ID! public_id of the eligible habit.
habitName - String! Display name of the habit.
Example
{
  "completions": 123,
  "daysSinceCreated": 987,
  "habitId": "4",
  "habitName": "abc123"
}

RevertLastGoalEventPayload

Description

Autogenerated return type of RevertLastGoalEvent.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

ReviewContentFlagPayload

Description

Autogenerated return type of ReviewContentFlag.

Fields
Field Name Description
contentFlag - ContentFlag
errors - [String!]!
Example
{
  "contentFlag": ContentFlag,
  "errors": ["abc123"]
}

ReviewContentReportPayload

Description

Autogenerated return type of ReviewContentReport.

Fields
Field Name Description
contentReport - ContentReport
errors - [String!]
Example
{
  "contentReport": ContentReport,
  "errors": ["abc123"]
}

RevokeAllyInvitePayload

Description

Autogenerated return type of RevokeAllyInvite.

Fields
Field Name Description
errors - [String!]!
invite - AllyInvite
Example
{
  "errors": ["abc123"],
  "invite": AllyInvite
}

RevokeCheckInTokenPayload

Description

Autogenerated return type of RevokeCheckInToken.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

RevokeTeamInvitePayload

Description

Autogenerated return type of RevokeTeamInvite.

Fields
Field Name Description
errors - [String!]!
teamInvite - TeamInvite
Example
{
  "errors": ["xyz789"],
  "teamInvite": TeamInvite
}

RunAiAutopilotNowPayload

Description

Autogenerated return type of RunAiAutopilotNow.

Fields
Field Name Description
autopilot - AiAutopilot
errors - [String!]!
run - AiRun
Example
{
  "autopilot": AiAutopilot,
  "errors": ["abc123"],
  "run": AiRun
}

SeasonalEvent

Description

A platform-wide, admin-curated seasonal event.

Fields
Field Name Description
badgeIcon - String! Emoji or icon string for the completion badge.
badgeName - String! Name of the badge awarded to event completers.
createdAtTime - String! Unix timestamp (string) when the event was created.
currentUserParticipant - SeasonalEventParticipant The current user's participation row, or nil.
description - String Optional description of the event.
endDate - ISO8601Date! Date when the event ends (inclusive).
isActive - Boolean! Whether this event is currently enabled by an admin.
isParticipating - Boolean! Whether the current user is an active participant.
name - String! Display name of the event.
participantCount - Int! Total number of active participants in the event.
publicId - ID! URL-safe public identifier for this event.
slug - String! URL-safe, unique identifier for this event.
startDate - ISO8601Date! Date when the event begins.
status - String! Date-derived status: "upcoming", "active", or "completed".
targetGoalCount - Int! Number of qualifying goal events required to complete the event.
updatedAtTime - String! Unix timestamp (string) when the event was last updated.
Example
{
  "badgeIcon": "xyz789",
  "badgeName": "xyz789",
  "createdAtTime": "xyz789",
  "currentUserParticipant": SeasonalEventParticipant,
  "description": "abc123",
  "endDate": ISO8601Date,
  "isActive": true,
  "isParticipating": false,
  "name": "abc123",
  "participantCount": 123,
  "publicId": "4",
  "slug": "xyz789",
  "startDate": ISO8601Date,
  "status": "abc123",
  "targetGoalCount": 123,
  "updatedAtTime": "abc123"
}

SeasonalEventParticipant

Description

A single user participation record within a seasonal event, tracking progress toward completion.

Fields
Field Name Description
completed - Boolean! Whether the participant has met the completion threshold.
completedAt - ISO8601DateTime When the target was crossed. Nil if not yet complete.
progressCount - Int! Number of qualifying goal events logged so far.
progressPercent - Float! Progress toward completion as a percentage (0–100), clamped.
publicId - ID! URL-safe public identifier for this participation record.
seasonalEvent - SeasonalEvent The event this participation belongs to.
user - User The participating user.
userPublicId - String Public ID of the participating user (safe for membership checks).
Example
{
  "completed": true,
  "completedAt": ISO8601DateTime,
  "progressCount": 123,
  "progressPercent": 987.65,
  "publicId": "4",
  "seasonalEvent": SeasonalEvent,
  "user": User,
  "userPublicId": "xyz789"
}

SeedBrokenStreakDebugPayload

Description

Autogenerated return type of SeedBrokenStreakDebug.

Fields
Field Name Description
errors - [String!]!
goal - Goal
repairXpCost - Int
Example
{
  "errors": ["abc123"],
  "goal": Goal,
  "repairXpCost": 987
}

SeedIntegrationActivityDebugPayload

Description

Autogenerated return type of SeedIntegrationActivityDebug.

Fields
Field Name Description
decision - String
errors - [String!]!
integrationActivity - IntegrationActivity
Example
{
  "decision": "xyz789",
  "errors": ["abc123"],
  "integrationActivity": IntegrationActivity
}

SeedWelcomeBackDebugPayload

Description

Autogenerated return type of SeedWelcomeBackDebug.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

SendAiChatMessagePayload

Description

Autogenerated return type of SendAiChatMessage.

Fields
Field Name Description
errors - [String!]!
message - AiChatMessage
Example
{
  "errors": ["xyz789"],
  "message": AiChatMessage
}

SendAllyRequestPayload

Description

Autogenerated return type of SendAllyRequest.

Fields
Field Name Description
alreadyRequested - Boolean!
errors - [String!]!
userAlly - UserAlly
Example
{
  "alreadyRequested": true,
  "errors": ["xyz789"],
  "userAlly": UserAlly
}

SendPactNudgePayload

Description

Autogenerated return type of SendPactNudge.

Fields
Field Name Description
errorCode - String Stable machine code for the failure: the failing interaction's snake_case code (e.g. not_found, taken). Null on success. An open set, so treat an unknown code like any other failure.
errors - [String!]!
pact - Pact
success - Boolean!
Example
{
  "errorCode": "xyz789",
  "errors": ["abc123"],
  "pact": Pact,
  "success": true
}

SendPartnerNudgePayload

Description

Autogenerated return type of SendPartnerNudge.

Fields
Field Name Description
errorCode - String Stable machine code for the failure: the failing interaction's snake_case code (e.g. not_found, taken). Null on success. An open set, so treat an unknown code like any other failure.
errors - [String!]!
success - Boolean!
Example
{
  "errorCode": "xyz789",
  "errors": ["abc123"],
  "success": false
}

SendPartnerRequestPayload

Description

Autogenerated return type of SendPartnerRequest.

Fields
Field Name Description
errors - [String!]!
userAlly - UserAlly
Example
{
  "errors": ["xyz789"],
  "userAlly": UserAlly
}

SetCoachGoalSuggestionsPreferencesPayload

Description

Autogenerated return type of SetCoachGoalSuggestionsPreferences.

Fields
Field Name Description
errors - [String!]!
preferences - CoachGoalSuggestionsPreferences
Example
{
  "errors": ["abc123"],
  "preferences": CoachGoalSuggestionsPreferences
}

SetColorThemePayload

Description

Autogenerated return type of SetColorTheme.

Fields
Field Name Description
colorTheme - String
errors - [String!]!
Example
{
  "colorTheme": "xyz789",
  "errors": ["xyz789"]
}

SetCommunityEditorialSlotPayload

Description

Autogenerated return type of SetCommunityEditorialSlot.

Fields
Field Name Description
community - Community
errors - [String!]
Example
{
  "community": Community,
  "errors": ["xyz789"]
}

SetCommunityEventRsvpPayload

Description

Autogenerated return type of SetCommunityEventRsvp.

Fields
Field Name Description
communityEvent - CommunityEvent
errorCode - String Stable machine code for the failure (N1), e.g. not_member.
errors - [String!]!
Example
{
  "communityEvent": CommunityEvent,
  "errorCode": "abc123",
  "errors": ["xyz789"]
}

SetCommunityFeaturedPayload

Description

Autogenerated return type of SetCommunityFeatured.

Fields
Field Name Description
community - Community
errors - [String!]
Example
{
  "community": Community,
  "errors": ["xyz789"]
}

SetCriticalPathActiveThemePayload

Description

Autogenerated return type of SetCriticalPathActiveTheme.

Fields
Field Name Description
errors - [String!]!
status - StimXpStatus
Example
{
  "errors": ["abc123"],
  "status": StimXpStatus
}

SetCriticalPathReminderPreferencesPayload

Description

Autogenerated return type of SetCriticalPathReminderPreferences.

Fields
Field Name Description
errors - [String!]!
preferences - CriticalPathReminderPreferences
Example
{
  "errors": ["xyz789"],
  "preferences": CriticalPathReminderPreferences
}

SetDefaultSubCommunityPayload

Description

Autogenerated return type of SetDefaultSubCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
Example
{
  "community": Community,
  "errors": ["abc123"]
}

SetGoalPartnerSharingPayload

Description

Autogenerated return type of SetGoalPartnerSharing.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

SetGoalVisibilityPayload

Description

Autogenerated return type of SetGoalVisibility.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["abc123"],
  "goal": Goal
}

SetLeaderboardVisibilityPayload

Description

Autogenerated return type of SetLeaderboardVisibility.

Fields
Field Name Description
errors - [String!]!
optedOut - Boolean
Example
{"errors": ["abc123"], "optedOut": true}

SetReminderNotificationPreferencesPayload

Description

Autogenerated return type of SetReminderNotificationPreferences.

Fields
Field Name Description
errors - [String!]!
preferences - ReminderNotificationPreferences
Example
{
  "errors": ["abc123"],
  "preferences": ReminderNotificationPreferences
}

SetSeasonalEventActivePayload

Description

Autogenerated return type of SetSeasonalEventActive.

Fields
Field Name Description
errors - [String!]
seasonalEvent - SeasonalEvent
Example
{
  "errors": ["xyz789"],
  "seasonalEvent": SeasonalEvent
}

SetSupporterMomentsMutedPayload

Description

Autogenerated return type of SetSupporterMomentsMuted.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": true}

SetTeamNotificationPreferencesPayload

Description

Autogenerated return type of SetTeamNotificationPreferences.

Fields
Field Name Description
errors - [String!]!
preferences - TeamNotificationPreferences
Example
{
  "errors": ["abc123"],
  "preferences": TeamNotificationPreferences
}

SetWeeklyDigestPreferencesPayload

Description

Autogenerated return type of SetWeeklyDigestPreferences.

Fields
Field Name Description
errors - [String!]!
preferences - WeeklyDigestPreferences
Example
{
  "errors": ["xyz789"],
  "preferences": WeeklyDigestPreferences
}

SetWelcomeSeriesPreferencesPayload

Description

Autogenerated return type of SetWelcomeSeriesPreferences.

Fields
Field Name Description
errors - [String!]!
preferences - WelcomeSeriesPreferences
Example
{
  "errors": ["xyz789"],
  "preferences": WelcomeSeriesPreferences
}

ShareEvent

Fields
Field Name Description
channel - String
code - String!
id - ID!
kind - String!
sharedAt - ISO8601DateTime!
subjectPublicId - String!
Example
{
  "channel": "abc123",
  "code": "abc123",
  "id": "4",
  "kind": "xyz789",
  "sharedAt": ISO8601DateTime,
  "subjectPublicId": "abc123"
}

ShareableMoment

Fields
Field Name Description
badgeIconUrl - String
badgeName - String
checkInCount - Int goal_completion only: earned check-ins on the journey.
daysTaken - Int goal_completion only: days from first check-in to last, inclusive.
displayName - String goal_completion only: the owner's own name as "First L.", or "First" with no last name. Null when the first name is blank — the client falls back to @username. Never an ally's name.
earnedOn - ISO8601Date The date the moment happened, in the caller's local timezone — earned date for a badge, completion date for a goal, today for a streak. Null for milestone.
encouragerCount - Int goal_completion only: distinct allies who encouraged it. A count, never an identity.
firstCheckInExcerpt - String goal_completion only: the first check-in note, at most 140 characters.
firstCheckInOn - ISO8601Date goal_completion only: the caller's local day of the first check-in. Null when there are none.
goalTitle - String
kind - String! One of: badge, goal_completion, milestone, streak.
lastCheckInExcerpt - String goal_completion only: the last check-in note, at most 140 characters.
lastCheckInOn - ISO8601Date goal_completion only: the caller's local day of the last check-in. Null when there are none.
milestoneIndex - Int
milestoneTitle - String
milestoneTotal - Int
shareCode - String! v4.56 Phase 5 (REF-01) — a code reserved for this preview, minted fresh per query. Unpersisted until recordShare is called with it; an abandoned preview simply never persists its code, so no ShareEvent row exists for it (SHARE-09).
streakAtFinish - Int goal_completion only: the user's streak as of the local completion day. Not per-goal. Null when there was none.
streakDays - Int
supporterMark - String The caller's collapsed Supporter presentation value: "supporter", "lifetime", or null when no active supporter tier. Distinct from UserType#supporterTier (the raw billing tier) — this is what a share card renders.
username - String The caller's own username, for building the shareable /u/:username link (REF-09). Null when the caller has no username — the client falls back to the app root.
Example
{
  "badgeIconUrl": "xyz789",
  "badgeName": "xyz789",
  "checkInCount": 987,
  "daysTaken": 987,
  "displayName": "abc123",
  "earnedOn": ISO8601Date,
  "encouragerCount": 123,
  "firstCheckInExcerpt": "xyz789",
  "firstCheckInOn": ISO8601Date,
  "goalTitle": "xyz789",
  "kind": "abc123",
  "lastCheckInExcerpt": "xyz789",
  "lastCheckInOn": ISO8601Date,
  "milestoneIndex": 987,
  "milestoneTitle": "xyz789",
  "milestoneTotal": 987,
  "shareCode": "abc123",
  "streakAtFinish": 123,
  "streakDays": 123,
  "supporterMark": "xyz789",
  "username": "abc123"
}

SmartCriterionEnum

Description

One of Coach's five SMART-read criteria: Clear, Countable, Doable, Yours, Dated.

Values
Enum Value Description

CLEAR

The goal names a specific, concrete outcome.

COUNTABLE

The goal has a measure — a target amount + unit, or a habit cadence. Milestones alone never satisfy this (D1, OBJ-5982 ROADMAP).

DATED

The goal has a target date, or a cadence/shape that makes one unnecessary.

DOABLE

The goal is realistically sized for its target date.

YOURS

The goal has a personal why — content or identityPrompt.
Example
"CLEAR"

StartAiChatPayload

Description

Autogenerated return type of StartAiChat.

Fields
Field Name Description
errors - [String!]!
session - AiChatSession
Example
{
  "errors": ["abc123"],
  "session": AiChatSession
}

StartChallengePayload

Description

Autogenerated return type of StartChallenge.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["abc123"],
  "goal": Goal
}

StartHeadCoachTurnPayload

Description

Autogenerated return type of StartHeadCoachTurn.

Fields
Field Name Description
conversationId - ID
errors - [String!]!
success - Boolean!
turnId - ID
Example
{
  "conversationId": 4,
  "errors": ["abc123"],
  "success": true,
  "turnId": "4"
}

StartTeamBillingPortalPayload

Description

Autogenerated return type of StartTeamBillingPortal.

Fields
Field Name Description
errors - [String!]!
portalUrl - String
Example
{
  "errors": ["xyz789"],
  "portalUrl": "abc123"
}

StartTeamCheckoutPayload

Description

Autogenerated return type of StartTeamCheckout.

Fields
Field Name Description
checkoutUrl - String
errors - [String!]!
Example
{
  "checkoutUrl": "xyz789",
  "errors": ["xyz789"]
}

StepInput

Description

Structured roadmap step input for UpdateGoal.steps. public_id distinguishes update (present) from create (absent). position is zero-based within the parent goal roadmap.

Fields
Input Field Description
name - String! Step label (server truncates to 50 chars).
position - Int! Zero-based ordinal within the parent goal roadmap.
publicId - ID Existing milestone public_id. Absent to create a new step.
targetDate - String Optional ISO target date (e.g. "2026-12-31").
Example
{
  "name": "xyz789",
  "position": 987,
  "publicId": "4",
  "targetDate": "xyz789"
}

StepOutOfPactPayload

Description

Autogenerated return type of StepOutOfPact.

Fields
Field Name Description
errors - [String!]!
pact - Pact
pactMembership - PactMembership
Example
{
  "errors": ["abc123"],
  "pact": Pact,
  "pactMembership": PactMembership
}

StimXpStatus

Description

The authenticated user's Stim XP and theme status.

Fields
Field Name Description
activeTheme - String! Active theme key; defaults to 'default' when unset.
currentStimStreak - Int! Current consecutive-day streak; 0 if streak is stale.
longestStimStreak - Int! All-time longest streak (used for theme unlock thresholds).
themesCatalog - [CriticalPathTheme!]! Full catalog of available themes.
totalStimXp - Int! Lifetime total Stim XP earned.
unlockedThemes - [String!]! Keys of themes the user has unlocked.
Example
{
  "activeTheme": "abc123",
  "currentStimStreak": 987,
  "longestStimStreak": 987,
  "themesCatalog": [CriticalPathTheme],
  "totalStimXp": 123,
  "unlockedThemes": ["xyz789"]
}

StoreDeviceTokenPayload

Description

Autogenerated return type of StoreDeviceToken.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

StoreFeatureTourStatePayload

Description

Autogenerated return type of StoreFeatureTourState.

Fields
Field Name Description
errors - [String!]!
featureTours - JSON
success - Boolean!
Example
{
  "errors": ["abc123"],
  "featureTours": {},
  "success": false
}

StoreOnboardingStatePayload

Description

Autogenerated return type of StoreOnboardingState.

Fields
Field Name Description
errors - [String!]!
user - User The current user, with the refreshed onboardingStatus field.
Example
{
  "errors": ["abc123"],
  "user": User
}

StoreUserDetailsPayload

Description

Autogenerated return type of StoreUserDetails.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

StreakJourney

Description

The user's current streak as a journey. Self only (v4.108 D8).

Fields
Field Name Description
days - Int! Days in the current streak.
firstCheckIn - JourneyCheckIn The earliest check-in within the streak.
lastCheckIn - JourneyCheckIn The latest check-in within the streak.
segments - [JourneySegment!]! One segment per streak day, in order. Every one counted, so all render lit.
Example
{
  "days": 987,
  "firstCheckIn": JourneyCheckIn,
  "lastCheckIn": JourneyCheckIn,
  "segments": [JourneySegment]
}

StreakRepairOffer

Description

Streak Repair offer shown to active users within 24–48h of a streak break.

Fields
Field Name Description
eligible - Boolean! Whether the user has an eligible streak repair right now.
goalName - String Name of the target habit goal. Null when ineligible.
goalPublicId - ID public_id of the habit goal eligible for repair. Null when ineligible.
insuranceClaimsRemaining - Int Streak insurance claims remaining in the current calendar month.
insuranceEligible - Boolean! Whether the user has an eligible free monthly streak insurance claim right now.
insuranceEligibleUntil - String ISO 8601 timestamp when the insurance window closes.
insuranceGoalName - String Name of the insurance target habit goal. Null when ineligible.
insuranceGoalPublicId - ID public_id of the habit goal eligible for insurance. Null when ineligible.
insurancePeriodResetsAt - String ISO 8601 timestamp when the monthly insurance allowance resets.
insurancePreBreakHabitStreak - Int Pre-break streak snapshot for the insurance target.
preBreakHabitStreak - Int Pre-break streak snapshot — the headline number to show users.
repairEligibleUntil - String ISO 8601 timestamp when the repair window closes.
repairXpCost - Int XP cost to repair this streak (100 + 5 × streak, capped at 500).
userIsSupporter - Boolean! Whether the user has an active Supporter subscription.
Example
{
  "eligible": true,
  "goalName": "xyz789",
  "goalPublicId": 4,
  "insuranceClaimsRemaining": 123,
  "insuranceEligible": true,
  "insuranceEligibleUntil": "abc123",
  "insuranceGoalName": "abc123",
  "insuranceGoalPublicId": 4,
  "insurancePeriodResetsAt": "xyz789",
  "insurancePreBreakHabitStreak": 987,
  "preBreakHabitStreak": 123,
  "repairEligibleUntil": "abc123",
  "repairXpCost": 123,
  "userIsSupporter": false
}

StreakRescueDay

Description

A day a freeze or repair kept in the streak, with which of the two it was.

Fields
Field Name Description
date - String! ISO date of the rescued day, in the user's timezone.
kind - HabitCompletionRescueKindEnum! Whether the day was a freeze or a repair.
Example
{"date": "abc123", "kind": "FREEZE"}

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"

SubmitEnneagramAssessmentPayload

Description

Autogenerated return type of SubmitEnneagramAssessment.

Fields
Field Name Description
assessment - EnneagramAssessment
errors - [String!]!
Example
{
  "assessment": EnneagramAssessment,
  "errors": ["abc123"]
}

SubmitTeamPulsePayload

Description

Autogenerated return type of SubmitTeamPulse.

Fields
Field Name Description
errors - [String!]!
record - TeamPulseConfirmation
Example
{
  "errors": ["abc123"],
  "record": TeamPulseConfirmation
}

SuccessorOffer

Description

A completed measure goal's "keep going" offer (v4.113 D1/D3/D4). Owner-only — null for anyone else, a habit, a milestone, a one-time goal, or an already-continued/closed offer.

Fields
Field Name Description
carriedAmount - Float! What the original goal is handing on: current_amount if present and > 0, else target_amount (D3).
declined - Boolean! Whether a celebration-surface decline has already been recorded (declineGoalSuccessor(CELEBRATION)). The offer still shows on the quiet card either way.
defaultTargetIndex - Int! Index into targets that should be preselected (the 2x chip).
suggestedName - String! A deterministic suggested title for the default target (D4).
targets - [SuccessorOfferTarget!]! 1.5x / 2x / 3x target chips (D3), snapped and de-duplicated.
unit - String! The original goal's unit, carried onto the offer.
Example
{
  "carriedAmount": 123.45,
  "declined": false,
  "defaultTargetIndex": 123,
  "suggestedName": "abc123",
  "targets": [SuccessorOfferTarget],
  "unit": "xyz789"
}

SuccessorOfferDeclineSurfaceEnum

Description

Which surface recorded a successor-offer decline (v4.113 D6).

Values
Enum Value Description

CARD

The quiet card's own dismiss. The offer never returns.

CELEBRATION

The settled goal-complete moment closing without an accept. The quiet card stays eligible.
Example
"CARD"

SuccessorOfferTarget

Description

One target chip on a successor offer (v4.113 D3): a snapped 1.5x/2x/3x multiple of the original goal's target_amount.

Fields
Field Name Description
amount - Float! The chip's target amount.
suggestedName - String! A deterministic suggested title for this chip's own target amount (D4).
suggestedTargetDate - ISO8601Date Suggested finish date at the owner's pace so far. Null when the original goal had no target_date.
Example
{
  "amount": 987.65,
  "suggestedName": "abc123",
  "suggestedTargetDate": ISO8601Date
}

SuggestGoalsPayload

Description

Autogenerated return type of SuggestGoals.

Fields
Field Name Description
aiRequest - AiRequest The AiRequest tracking this call, resolved by Ai::DispatchAiRequestJob (v4.60). Subscribe to aiRequestUpdate(requestId: id) or poll aiRequest(id:) for the result. Null only on the fallback failure payload.
errors - [String!]!
suggestions - [SuggestedGoal!]
Example
{
  "aiRequest": AiRequest,
  "errors": ["xyz789"],
  "suggestions": [SuggestedGoal]
}

SuggestedCommunity

Description

A community recommended to a user based on their goals, interests, and ally network.

Fields
Field Name Description
activeMembers - Int! Count of members who posted or commented in the past 7 days.
category - String! Category label for the community (e.g. "Fitness", "Learning").
coverImage - String URL of the community banner/cover image.
description - String Human-readable description of the community purpose.
isRecommended - Boolean! Always true for suggested communities — indicates this is a curated recommendation.
matchScore - Int! Relevance score (0–100) indicating how well this community matches the user.
members - [DiscoveryMember!]! A sample of up to 5 members, useful for showing mutual connections.
mutualAllies - Int! Number of the current user allies who are also members of this community.
name - String! Display name of the community.
publicId - ID! URL-safe public identifier for this community.
reason - CommunityReason The single disclosable reason this community is recommended, or null if none applies.
Example
{
  "activeMembers": 123,
  "category": "abc123",
  "coverImage": "xyz789",
  "description": "abc123",
  "isRecommended": true,
  "matchScore": 123,
  "members": [DiscoveryMember],
  "mutualAllies": 123,
  "name": "abc123",
  "publicId": "4",
  "reason": CommunityReason
}

SuggestedGoal

Description

A Coach-suggested goal from the goal-discovery quiz: title, category, kind, target date, rationale, and milestones.

Fields
Field Name Description
categoryId - ID Resolved GoalCategory id, or null if the suggested category was unknown.
categoryName - String
kindId - ID Resolved GoalType id, or null if the suggested kind was unknown.
kindName - String
milestones - [String!]!
rationale - String One sentence on why this goal fits the quiz answers.
targetDate - String Suggested ISO8601 target date, or null for habits/ongoing goals.
title - String
Example
{
  "categoryId": 4,
  "categoryName": "xyz789",
  "kindId": "4",
  "kindName": "xyz789",
  "milestones": ["xyz789"],
  "rationale": "abc123",
  "targetDate": "abc123",
  "title": "abc123"
}

SupporterMoments

Description

Seen-state and mute flag for in-app supporter moments.

Fields
Field Name Description
lastShownAt - String ISO8601 timestamp of the most recently shown supporter moment.
muted - Boolean! True once the user has muted all supporter moments.
seenKeys - [String!]! Keys of supporter moments already shown to this user.
Example
{
  "lastShownAt": "xyz789",
  "muted": false,
  "seenKeys": ["abc123"]
}

SupporterStats

Description

Supporter revenue and tier-count aggregation for admin analytics

Fields
Field Name Description
activeSupportersLifetime - Int!
activeSupportersMonthly - Int!
activeSupportersTotal - Int!
activeSupportersYearly - Int!
currency - String!
mrrCents - Int! Monthly Recurring Revenue in cents (monthly + yearly/12)
Example
{
  "activeSupportersLifetime": 987,
  "activeSupportersMonthly": 123,
  "activeSupportersTotal": 123,
  "activeSupportersYearly": 123,
  "currency": "xyz789",
  "mrrCents": 987
}

SyncUserPayload

Description

Autogenerated return type of SyncUser.

Fields
Field Name Description
errors - [String!]!
firstSignIn - Boolean!
user - User
Example
{
  "errors": ["abc123"],
  "firstSignIn": true,
  "user": User
}

SystemHealth

Description

Admin self-health probe data. Admin only.

Fields
Field Name Description
agentRunnerReachable - Boolean!
currentAdminPublicId - String!
currentAdminRoleList - [String!]!
databaseReachable - Boolean!
deployRevision - String
deployTimestamp - String
litellmReachable - Boolean!
redisReachable - Boolean!
sidekiqReachable - Boolean!
Example
{
  "agentRunnerReachable": true,
  "currentAdminPublicId": "abc123",
  "currentAdminRoleList": ["abc123"],
  "databaseReachable": false,
  "deployRevision": "xyz789",
  "deployTimestamp": "abc123",
  "litellmReachable": true,
  "redisReachable": false,
  "sidekiqReachable": true
}

Team

Description

A paid, private, multi-community workspace (Teams V1).

Fields
Field Name Description
billingOwner - User! The user who owns billing for this team.
coachName - String! The team's billing owner first name, shown as "Coached by" (OBJ-1830).
memberCount - Int! Total number of memberships on this team (OBJ-1830).
memberships - [TeamMembership!]! All current members of this team.
name - String! Display name of the team.
publicId - ID! URL-safe public identifier for this team.
slug - String! URL-safe slug for the team.
subscription - TeamSubscription The team billing subscription, if provisioned.
Example
{
  "billingOwner": User,
  "coachName": "xyz789",
  "memberCount": 987,
  "memberships": [TeamMembership],
  "name": "abc123",
  "publicId": 4,
  "slug": "xyz789",
  "subscription": TeamSubscription
}

TeamFeedItem

Description

A row in TeamHomeView's Today feed. Always empty in Phase 3 (Orion A1 — no activity feed model yet).

Fields
Field Name Description
actorName - String!
actorPhotoUrl - String
id - ID!
kind - String!
message - String
occurredAt - ISO8601DateTime!
points - Int
Example
{
  "actorName": "abc123",
  "actorPhotoUrl": "xyz789",
  "id": "4",
  "kind": "xyz789",
  "message": "xyz789",
  "occurredAt": ISO8601DateTime,
  "points": 123
}

TeamHome

Description

Aggregate read backing TeamHomeView (N13).

Fields
Field Name Description
activeRoomId - ID The public_id of the viewer's active sub-community.
billingState - String trial_ending, past_due, grace_readonly, or null when the subscription needs no banner (active/canceled).
collectiveGoal - CollectiveGoal The team-wide collective goal, if any. Null when none exists yet.
collectiveGoalPrivacyContractAcknowledged - Boolean! Whether the viewer has acknowledged TeamPrivacyContractView (N18) server-side (UserAction), never localStorage.
feed - [TeamFeedItem!]! Always empty in Phase 3 — see TeamFeedItemType's description.
isFreshMember - Boolean! True when the viewer has no team activity yet (drives the empty state).
role - String! The viewer's TeamMembership role on this team.
rooms - [Community!]! The team's non-archived sub-communities (room strip / switcher).
team - Team! The team.
trialDaysLeft - Int Days left in trial, clamped to >= 0. Null outside trialing.
Example
{
  "activeRoomId": "4",
  "billingState": "abc123",
  "collectiveGoal": CollectiveGoal,
  "collectiveGoalPrivacyContractAcknowledged": true,
  "feed": [TeamFeedItem],
  "isFreshMember": false,
  "role": "abc123",
  "rooms": [Community],
  "team": Team,
  "trialDaysLeft": 987
}

TeamInsight

Description

Team-period aggregates for owners and admins. Members who opted out of the leaderboard are excluded from every points and check-ins figure but still count in headcount. The trend covers current members only (removing a member deletes their leaderboard rows).

Fields
Field Name Description
activeMembers - Int! Members active since the start of the period (any recorded activity for all_time).
boardMemberCount - Int! Seated members who have not opted out of the leaderboard. Zero means every points and check-ins figure is empty by privacy, not a confirmed zero.
checkinTrend - [TeamInsightTrendPoint!]! Weekly team check-ins for the last 12 weeks, oldest first.
collectiveGoals - [TeamInsightGoal!]! Progress of the team's collective goals.
inactiveMembers - Int! Members inactive for 14 days or more.
period - String! weekly, monthly, or all_time (all_time is within the team, never lifetime).
rooms - [TeamInsightRoom!]! Per-room member count and check-ins for the period.
teamCheckins - Int! Team check-ins for the period. Opted-out members are excluded.
teamPoints - Int! Team points for the period. Opted-out members are excluded.
totalMembers - Int! Seated members, including those who opted out of the leaderboard.
Example
{
  "activeMembers": 987,
  "boardMemberCount": 987,
  "checkinTrend": [TeamInsightTrendPoint],
  "collectiveGoals": [TeamInsightGoal],
  "inactiveMembers": 987,
  "period": "xyz789",
  "rooms": [TeamInsightRoom],
  "teamCheckins": 123,
  "teamPoints": 123,
  "totalMembers": 987
}

TeamInsightGoal

Description

Progress of one team collective goal within Team Insight. Aggregate only — no per-member contributions.

Fields
Field Name Description
name - String! Goal name.
progress - Int! Events contributed so far by members with an active contribution.
reachedAt - ISO8601DateTime When the goal was reached. Null while in progress.
targetValue - Int! Target for the goal.
Example
{
  "name": "xyz789",
  "progress": 123,
  "reachedAt": ISO8601DateTime,
  "targetValue": 123
}

TeamInsightRoom

Description

Member count and check-ins for one team room (sub-community) within Team Insight.

Fields
Field Name Description
boardMemberCount - Int! Room members who have not opted out of the leaderboard. Zero means the room's check-ins are empty by privacy, not a confirmed zero.
checkins - Int! Check-ins counted in the room for the period. Opted-out members are excluded (D3).
id - String! The room's Community public_id.
memberCount - Int! Members of the room, including members who opted out of the leaderboard.
name - String! Room name.
Example
{
  "boardMemberCount": 123,
  "checkins": 987,
  "id": "xyz789",
  "memberCount": 123,
  "name": "xyz789"
}

TeamInsightTrendPoint

Description

Team check-ins for one week within Team Insight. Opted-out members are excluded (D3).

Fields
Field Name Description
checkins - Int! Check-ins counted toward the team that week. Zero when there are no rows.
weekStart - ISO8601Date! Monday that starts this week.
Example
{"checkins": 123, "weekStart": ISO8601Date}

TeamInvite

Description

A link (and optionally email-targeted) invite to join a Team.

Fields
Field Name Description
code - String! URL-safe invite code — embed in the join link.
email - String Invitee email, or null for a link-only invite.
expiresAt - ISO8601DateTime! When this invite expires (14 days from creation).
id - ID! Public identifier for this invite record.
maxUses - Int Maximum number of times this invite may be accepted.
status - String! Current status: pending, accepted, revoked, or expired.
teamRole - String! Role the invitee will hold once accepted: admin or member.
usedCount - Int! Number of times this invite has been accepted.
Example
{
  "code": "xyz789",
  "email": "abc123",
  "expiresAt": ISO8601DateTime,
  "id": "4",
  "maxUses": 123,
  "status": "xyz789",
  "teamRole": "abc123",
  "usedCount": 987
}

TeamInvitePreview

Description

Public preview of a team invite — safe for an unauthenticated visitor before they sign up or accept. Never reveals whether an unavailable invite was revoked, expired, or exhausted.

Fields
Field Name Description
inviterName - String The inviter's first name. Present only when status is valid.
memberCount - Int Current team member count. Present only when status is valid.
status - String! "valid", "unavailable" (expired, revoked, or exhausted — indistinguishable by design), or "not_found".
teamName - String The inviting team's name. Present only when status is valid.
Example
{
  "inviterName": "abc123",
  "memberCount": 123,
  "status": "xyz789",
  "teamName": "abc123"
}

TeamLeaderboard

Description

Aggregate read backing TeamLeaderboardView (N19).

Fields
Field Name Description
entries - [TeamLeaderboardEntry!]! Ranked, opted-in entries for the requested scope.
period - String! weekly, monthly, or all_time.
rooms - [Community!]! The team's non-archived sub-communities, for the scope picker (OBJ-1826).
team - Team! The team this leaderboard belongs to.
yourMembershipOptedOut - Boolean! Whether the requesting member has opted out of the leaderboard themselves.
Example
{
  "entries": [TeamLeaderboardEntry],
  "period": "xyz789",
  "rooms": [Community],
  "team": Team,
  "yourMembershipOptedOut": false
}

TeamLeaderboardEntry

Description

A single denormalized row on a team leaderboard bucket.

Fields
Field Name Description
isYou - Boolean! Whether this row belongs to the requesting user.
points - Int! Total points accrued in this bucket.
rank - Int! Position within the current bucket (1 = highest points).
trend - String! up, down, or flat vs. the immediately preceding bucket.
user - User! The team member this entry belongs to.
Example
{
  "isYou": false,
  "points": 987,
  "rank": 987,
  "trend": "xyz789",
  "user": User
}

TeamLeaderboardOptOutStat

Description

Per-team leaderboard opt-out raw count (PRD anti-metric monitoring). Admin-only.

Fields
Field Name Description
memberCount - Int! Total memberships on this team.
optedOutCount - Int! Raw count of members opted out of the leaderboard.
teamName - String! The team name.
Example
{
  "memberCount": 123,
  "optedOutCount": 987,
  "teamName": "xyz789"
}

TeamMemberActivity

Description

Read-only team-scoped activity summary for one member (N7b "View activity"). Owner/admin only — see Resolvers::TeamQueries#team_member_activity.

Fields
Field Name Description
collectiveGoalContributions - Int! Count of events contributed across the team's collective goals.
lastActiveDays - Int Days since the member was last active, day granularity. Null when no activity has been recorded yet.
lastActiveLabel - String! Humanized last-active label: "Active today" / "Active yesterday" / "Active Nd ago" / "Inactive Nd" / "Not recorded yet", day granularity only.
optedOut - Boolean! Whether the member has opted out of the team leaderboard — render the opt-out copy instead of points/check-ins.
periodStats - [TeamMemberActivityPeriodStat!]! Team points earned and check-ins, one row per period (weekly, monthly, all_time).
subCommunityNames - [String!]! Names of the sub-communities this member belongs to.
Example
{
  "collectiveGoalContributions": 123,
  "lastActiveDays": 123,
  "lastActiveLabel": "xyz789",
  "optedOut": false,
  "periodStats": [TeamMemberActivityPeriodStat],
  "subCommunityNames": ["xyz789"]
}

TeamMemberActivityPeriodStat

Description

Points and check-ins for one leaderboard period bucket, within Team Member Activity (OBJ-1823).

Fields
Field Name Description
checkins - Int Check-ins counted toward the team in this bucket. Null when the member has opted out.
period - String! weekly, monthly, or all_time.
points - Int Team points earned in this bucket. Null when the member has opted out.
Example
{
  "checkins": 123,
  "period": "xyz789",
  "points": 987
}

TeamMemberRosterRow

Description

One member row in Manager View: identity plus the contract-bound activity summary.

Fields
Field Name Description
activity - TeamMemberActivity! Activity summary, identical to Query.teamMemberActivity for this member.
member - TeamMemberSummary! Member identity, same shape as Team Settings → Members.
Example
{
  "activity": TeamMemberActivity,
  "member": TeamMemberSummary
}

TeamMemberSummary

Description

A member row in Team Settings → Members (N7b).

Fields
Field Name Description
activityLabel - String! Humanized last-active label: "Active today" / "Active yesterday" / "Active Nd ago" / "Inactive Nd" / "Not recorded yet".
firstName - String! The member's first name.
isInactive - Boolean! True when no activity in the trailing 14 days.
joinedLabel - String! Humanized "joined N ago" label.
lastName - String The member's last name.
photoUrl - String The member's avatar URL, or nil (falls back to initials).
publicId - ID! The member's public identifier (their User public_id).
role - String! Display role: owner, admin, member, external_coach, lead, or coach. "lead" and "coach" are display-only labels layered over the underlying TeamMembership role — see PromoteTeamMember for the persisted role values.
roomIds - [ID!]! Community public_ids this member belongs to. Empty array if none.
teamMembershipId - ID! This member's TeamMembership public_id — the id promote/remove mutations take.
Example
{
  "activityLabel": "abc123",
  "firstName": "abc123",
  "isInactive": false,
  "joinedLabel": "xyz789",
  "lastName": "xyz789",
  "photoUrl": "abc123",
  "publicId": 4,
  "role": "xyz789",
  "roomIds": [4],
  "teamMembershipId": 4
}

TeamMembership

Description

A user's seat on a Team.

Fields
Field Name Description
joinedAt - ISO8601DateTime! When this member joined the team.
publicId - ID! URL-safe public identifier for this membership.
role - String! owner, admin, member, or external_coach.
user - User! The member.
Example
{
  "joinedAt": ISO8601DateTime,
  "publicId": "4",
  "role": "abc123",
  "user": User
}

TeamNotificationPreferences

Description

Team notification preferences for the authenticated user.

Fields
Field Name Description
enabled - Boolean! Whether the user receives in-app and push notifications from their teams.
Example
{"enabled": false}

TeamPendingInvite

Description

A pending invite row in the Members (N7b) or Invites (N7d) tab.

Fields
Field Name Description
code - String! The invite code (used to build the join link for Copy).
email - String Invitee email, or null for a link-only invite.
expiresAt - ISO8601DateTime! When this invite expires.
id - ID! Public identifier for this invite.
sentLabel - String! Humanized duration since sent (e.g. "2 days") — no trailing "ago"; TeamMembersTab.vue/TeamInvitesTab.vue append "ago" themselves ("Sent {sentLabel} ago").
status - String! pending, accepted, revoked, or expired.
Example
{
  "code": "xyz789",
  "email": "abc123",
  "expiresAt": ISO8601DateTime,
  "id": 4,
  "sentLabel": "abc123",
  "status": "xyz789"
}

TeamPulseConfirmation

Description

Confirmation that a team pulse survey response was recorded.

Fields
Field Name Description
period - String! The quarter period this response was recorded for (e.g. "2026-Q3").
Example
{"period": "xyz789"}

TeamSettings

Description

Aggregate read backing Team Settings (N7): Members, Sub-Communities, and Invites tabs.

Fields
Field Name Description
maxSubCommunities - Int! Sub-community cap for this team (N7c header count).
members - [TeamMemberSummary!]! Every current team member.
pendingInvites - [TeamPendingInvite!]! Invites still awaiting acceptance.
role - String! The viewer's TeamMembership role on this team.
seatLimit - Int The team's subscription seat count, or nil when unprovisioned.
seatsUsed - Int! Current member count.
subCommunities - [Community!]! Every sub-community for this team, including archived ones (N7c renders archived rooms in a read-only 30-day window).
team - Team! The team.
Example
{
  "maxSubCommunities": 123,
  "members": [TeamMemberSummary],
  "pendingInvites": [TeamPendingInvite],
  "role": "xyz789",
  "seatLimit": 987,
  "seatsUsed": 123,
  "subCommunities": [Community],
  "team": Team
}

TeamSubscription

Description

A Team billing subscription — plan, seats, and lifecycle status.

Fields
Field Name Description
currentPeriodEnd - ISO8601DateTime End of the current billing period.
plan - Plan! The Teams plan this subscription is on.
publicId - ID! URL-safe public identifier for this subscription.
seatCount - Int! Number of seats currently provisioned.
status - String! Lifecycle status: trialing, active, past_due, grace, or canceled.
trialEndsAt - ISO8601DateTime When the free trial ends, if trialing.
Example
{
  "currentPeriodEnd": ISO8601DateTime,
  "plan": Plan,
  "publicId": "4",
  "seatCount": 987,
  "status": "abc123",
  "trialEndsAt": ISO8601DateTime
}

TeamSwitcherEntry

Description

One row of the viewer's myTeams list (OBJ-1821) — the team switcher never fetches a membership's user.

Fields
Field Name Description
role - String! owner, admin, member, or external_coach.
team - Team! The team this membership belongs to.
Example
{
  "role": "xyz789",
  "team": Team
}

TickPactRulePayload

Description

Autogenerated return type of TickPactRule.

Fields
Field Name Description
errors - [String!]!
pact - Pact
pactTick - PactTick
Example
{
  "errors": ["abc123"],
  "pact": Pact,
  "pactTick": PactTick
}

ToggleFeedbackVotePayload

Description

Autogenerated return type of ToggleFeedbackVote.

Fields
Field Name Description
errors - [String!]!
feedbackPost - FeedbackPost
voted - Boolean
Example
{
  "errors": ["xyz789"],
  "feedbackPost": FeedbackPost,
  "voted": false
}

ToggleFollowGoalPayload

Description

Autogenerated return type of ToggleFollowGoal.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["xyz789"],
  "result": Result
}

TopPost

Fields
Field Name Description
channel - String!
clicks - Float
engagementRate - Float
impressions - Float
sentOn - String
text - String!
Example
{
  "channel": "xyz789",
  "clicks": 123.45,
  "engagementRate": 987.65,
  "impressions": 987.65,
  "sentOn": "xyz789",
  "text": "xyz789"
}

TourFunnel

Description

Aggregated tour-completion funnel counts for a single tour id. Admin only. Returns aggregates only — no user identifiers.

Fields
Field Name Description
completed - Int! Users who completed this tour (completed_at present).
completionRate - Float completed / started. Null when started is zero.
dismissed - Int! Users who skipped/dismissed this tour without completing.
started - Int! Lower-bound proxy: users with a persisted completed_at or dismissed=true entry for this tour. feature_tours never records a raw start event — true start volume lives in PostHog (tour_started).
tourId - String! Tour identifier, matching ionic_frontend TOUR_REGISTRY tourId (e.g. "dashboard-first-run").
Example
{
  "completed": 987,
  "completionRate": 987.65,
  "dismissed": 123,
  "started": 987,
  "tourId": "xyz789"
}

TransferTeamBillingOwnershipPayload

Description

Autogenerated return type of TransferTeamBillingOwnership.

Fields
Field Name Description
errors - [String!]!
team - Team
Example
{
  "errors": ["xyz789"],
  "team": Team
}

TrendingCommunity

Description

A community currently trending based on member growth and activity metrics.

Fields
Field Name Description
activeMembers - Int! Count of members who posted or commented in the past 7 days.
category - String! Category label for the community (e.g. "Fitness", "Learning").
coverImage - String URL of the community banner/cover image.
description - String Human-readable description of the community purpose.
growthRate - Float! Percentage growth in membership over the past 7 days.
isTrending - Boolean! Always true for trending communities — indicates current trending status.
name - String! Display name of the community.
publicId - ID! URL-safe public identifier for this community.
reason - CommunityReason The single disclosable reason this community is trending, or null if none applies.
totalGoals - Int! Total number of goals shared in this community.
totalMembers - Int! Total member count.
Example
{
  "activeMembers": 987,
  "category": "xyz789",
  "coverImage": "abc123",
  "description": "abc123",
  "growthRate": 987.65,
  "isTrending": true,
  "name": "abc123",
  "publicId": 4,
  "reason": CommunityReason,
  "totalGoals": 987,
  "totalMembers": 123
}

TriggerAiRunPayload

Description

Autogenerated return type of TriggerAiRun.

Fields
Field Name Description
errors - [String!]!
run - AiRun
Example
{
  "errors": ["xyz789"],
  "run": AiRun
}

UnarchiveSubCommunityPayload

Description

Autogenerated return type of UnarchiveSubCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
Example
{
  "community": Community,
  "errors": ["xyz789"]
}

UnblockAllyPayload

Description

Autogenerated return type of UnblockAlly.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": false}

UndoAiArtifactApprovalPayload

Description

Autogenerated return type of UndoAiArtifactApproval.

Fields
Field Name Description
errors - [String!]!
results - [AiArtifactBulkResult!]!
Example
{
  "errors": ["abc123"],
  "results": [AiArtifactBulkResult]
}

UndoCoachProposalPayload

Description

Autogenerated return type of UndoCoachProposal.

Fields
Field Name Description
coachProposal - CoachProposal The proposal after the call; null if it does not exist for this user.
errors - [String!]!
Example
{
  "coachProposal": CoachProposal,
  "errors": ["abc123"]
}

UndoHeadCoachActionPayload

Description

Autogenerated return type of UndoHeadCoachAction.

Fields
Field Name Description
action - HeadCoachAction
errors - [String!]!
success - Boolean!
Example
{
  "action": HeadCoachAction,
  "errors": ["abc123"],
  "success": false
}

UnfollowCommunityPayload

Description

Autogenerated return type of UnfollowCommunity.

Fields
Field Name Description
errors - [String!]!
result - Result
Example
{
  "errors": ["abc123"],
  "result": Result
}

UnifiedFeed

Description

Paginated unified activity feed.

Fields
Field Name Description
allyBadges - [FeedAllyBadge!]! Ally badges that didn't attach to a visible row, for the feed's weekly collapse (G4, v4.123). Populated on the first page only (offset 0, non-cheerable); empty otherwise.
hasMore - Boolean! Whether there are more items beyond this page.
items - [UnifiedFeedItem!]! Feed items for the current page.
totalCount - Int! Total number of feed items across all sources.
Example
{
  "allyBadges": [FeedAllyBadge],
  "hasMore": true,
  "items": [UnifiedFeedItem],
  "totalCount": 123
}

UnifiedFeedItem

Description

A single item in the unified activity feed.

Fields
Field Name Description
action - String! Action verb (e.g. "checked in on", "posted in").
actorId - String public_id of the acting user.
actorName - String Display name of the user who performed the action.
actorPhoto - String Photo URL of the acting user.
badgeKey - String Badge action key (e.g. complete_first_goal) when feed_type=notification and action=badge.
communityId - String Community public_id if applicable.
communityName - String Community name if applicable.
content - String Body text or excerpt of the feed item.
earnedBadges - [FeedEarnedBadge!]! Badges this check-in or goal event earned for its owner (G2, v4.123). Empty when none attached.
feedType - String! Source type: ally_activity, community_post, notification, or own_activity.
goalEventId - ID public_id of the goal event behind ally_activity and own_activity items; null otherwise.
id - String! Unique identifier for this feed item (prefixed by source type).
loggedLate - Boolean! True when the entry was logged after its day. Boolean only, no day count.
targetId - String public_id of the target entity.
targetName - String Name of the goal or community acted upon.
targetType - String Entity type: goal or community.
timestamp - String! Unix timestamp as a string.
viewerCheered - Boolean! True when the viewer has already encouraged the goal event behind this item.
viewerCheeredGoalToday - Boolean! Whether the viewer has already cheered this item's goal today (G3, v4.123). Always false on non-ally_activity rows.
viewerEncouragement - Encouragement The viewer's live encouragement on the goal event behind this item; null when they have none or withdrew it.
Example
{
  "action": "abc123",
  "actorId": "xyz789",
  "actorName": "abc123",
  "actorPhoto": "xyz789",
  "badgeKey": "xyz789",
  "communityId": "xyz789",
  "communityName": "abc123",
  "content": "abc123",
  "earnedBadges": [FeedEarnedBadge],
  "feedType": "abc123",
  "goalEventId": 4,
  "id": "abc123",
  "loggedLate": true,
  "targetId": "abc123",
  "targetName": "xyz789",
  "targetType": "xyz789",
  "timestamp": "abc123",
  "viewerCheered": false,
  "viewerCheeredGoalToday": true,
  "viewerEncouragement": Encouragement
}

UnlinkPactRuleSyncPayload

Description

Autogenerated return type of UnlinkPactRuleSync.

Fields
Field Name Description
errors - [String!]!
pactRule - PactRule
Example
{
  "errors": ["xyz789"],
  "pactRule": PactRule
}

UnlinkPracticePayload

Description

Autogenerated return type of UnlinkPractice.

Fields
Field Name Description
errors - [String!]!
practice - Goal
Example
{
  "errors": ["xyz789"],
  "practice": Goal
}

UnpinAdminDashboardCardPayload

Description

Autogenerated return type of UnpinAdminDashboardCard.

Fields
Field Name Description
errors - [String!]!
success - Boolean!
Example
{"errors": ["xyz789"], "success": false}

UntickPactRulePayload

Description

Autogenerated return type of UntickPactRule.

Fields
Field Name Description
errors - [String!]!
pact - Pact
Example
{
  "errors": ["abc123"],
  "pact": Pact
}

UpdateAiAssignmentPayload

Description

Autogenerated return type of UpdateAiAssignment.

Fields
Field Name Description
assignment - AiAssignment
errors - [String!]!
Example
{
  "assignment": AiAssignment,
  "errors": ["abc123"]
}

UpdateAiAutopilotPayload

Description

Autogenerated return type of UpdateAiAutopilot.

Fields
Field Name Description
autopilot - AiAutopilot
errors - [String!]!
Example
{
  "autopilot": AiAutopilot,
  "errors": ["abc123"]
}

UpdateAiEmployeePayload

Description

Autogenerated return type of UpdateAiEmployee.

Fields
Field Name Description
employee - AiEmployee
errors - [String!]!
Example
{
  "employee": AiEmployee,
  "errors": ["abc123"]
}

UpdateCelebrationPreferencesPayload

Description

Autogenerated return type of UpdateCelebrationPreferences.

Fields
Field Name Description
celebrationPreferences - CelebrationPreferences
errors - [String!]!
Example
{
  "celebrationPreferences": CelebrationPreferences,
  "errors": ["abc123"]
}

UpdateChallengePayload

Description

Autogenerated return type of UpdateChallenge.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

UpdateCharterPreferencesPayload

Description

Autogenerated return type of UpdateCharterPreferences.

Fields
Field Name Description
errors - [String!]!
user - User
Example
{
  "errors": ["abc123"],
  "user": User
}

UpdateCoachModelPayload

Description

Autogenerated return type of UpdateCoachModel.

Fields
Field Name Description
errors - [String!]!
setting - CoachModelSetting
Example
{
  "errors": ["xyz789"],
  "setting": CoachModelSetting
}

UpdateCoachWarmupContextPayload

Description

Autogenerated return type of UpdateCoachWarmupContext.

Fields
Field Name Description
errors - [String!]!
userDetail - UserDetail
Example
{
  "errors": ["xyz789"],
  "userDetail": UserDetail
}

UpdateCoachingPreferencesPayload

Description

Autogenerated return type of UpdateCoachingPreferences.

Fields
Field Name Description
coachingPreferences - CoachingPreferences
errors - [String!]!
Example
{
  "coachingPreferences": CoachingPreferences,
  "errors": ["xyz789"]
}

UpdateCommunityEventPayload

Description

Autogenerated return type of UpdateCommunityEvent.

Fields
Field Name Description
communityEvent - CommunityEvent
errorCode - String Stable machine code for the failure (N1), e.g. event_ended.
errors - [String!]!
Example
{
  "communityEvent": CommunityEvent,
  "errorCode": "abc123",
  "errors": ["xyz789"]
}

UpdateDashboardPreferencesPayload

Description

Autogenerated return type of UpdateDashboardPreferences.

Fields
Field Name Description
dashboardPreferences - DashboardPreferences
errors - [String!]!
Example
{
  "dashboardPreferences": DashboardPreferences,
  "errors": ["abc123"]
}

UpdateDemoCommunityPayload

Description

Autogenerated return type of UpdateDemoCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
Example
{
  "community": Community,
  "errors": ["xyz789"]
}

UpdateDemoGoalPayload

Description

Autogenerated return type of UpdateDemoGoal.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["abc123"],
  "goal": Goal
}

UpdateDemoUserPayload

Description

Autogenerated return type of UpdateDemoUser.

Fields
Field Name Description
errors - [String!]!
user - User
Example
{
  "errors": ["xyz789"],
  "user": User
}

UpdateFeedbackPostStatusPayload

Description

Autogenerated return type of UpdateFeedbackPostStatus.

Fields
Field Name Description
errors - [String!]!
feedbackPost - FeedbackPost
Example
{
  "errors": ["xyz789"],
  "feedbackPost": FeedbackPost
}

UpdateFeedbackPostTagsPayload

Description

Autogenerated return type of UpdateFeedbackPostTags.

Fields
Field Name Description
errors - [String!]!
feedbackPost - FeedbackPost
Example
{
  "errors": ["abc123"],
  "feedbackPost": FeedbackPost
}

UpdateFeedbackTagPayload

Description

Autogenerated return type of UpdateFeedbackTag.

Fields
Field Name Description
errors - [String!]!
feedbackTag - FeedbackTag
Example
{
  "errors": ["abc123"],
  "feedbackTag": FeedbackTag
}

UpdateGoalEventPayload

Description

Autogenerated return type of UpdateGoalEvent.

Fields
Field Name Description
errors - [String!]!
goalEvent - GoalEvent
Example
{
  "errors": ["xyz789"],
  "goalEvent": GoalEvent
}

UpdateGoalMotivationSnapshotPayload

Description

Autogenerated return type of UpdateGoalMotivationSnapshot.

Fields
Field Name Description
errors - [String!]!
goalMotivationProfile - GoalMotivationProfile
Example
{
  "errors": ["abc123"],
  "goalMotivationProfile": GoalMotivationProfile
}

UpdateGoalPayload

Description

Autogenerated return type of UpdateGoal.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["xyz789"],
  "goal": Goal
}

UpdatePactPayload

Description

Autogenerated return type of UpdatePact.

Fields
Field Name Description
errors - [String!]!
pact - Pact
Example
{
  "errors": ["abc123"],
  "pact": Pact
}

UpdatePrivacySettingsPayload

Description

Autogenerated return type of UpdatePrivacySettings.

Fields
Field Name Description
errors - [String!]!
user - User
Example
{
  "errors": ["xyz789"],
  "user": User
}

UpdateSeasonalEventPayload

Description

Autogenerated return type of UpdateSeasonalEvent.

Fields
Field Name Description
errors - [String!]
seasonalEvent - SeasonalEvent
Example
{
  "errors": ["abc123"],
  "seasonalEvent": SeasonalEvent
}

UpdateShowcasedAchievementsPayload

Description

Autogenerated return type of UpdateShowcasedAchievements.

Fields
Field Name Description
errors - [String!]
success - Boolean!
Example
{"errors": ["abc123"], "success": false}

UpdateSubCommunityPayload

Description

Autogenerated return type of UpdateSubCommunity.

Fields
Field Name Description
community - Community
errors - [String!]!
teamReadOnly - Boolean! True only for the grace-period read-only failure — the frontend renders its own "team is read-only" copy for this.
Example
{
  "community": Community,
  "errors": ["abc123"],
  "teamReadOnly": false
}

UpdateUserPayload

Description

Autogenerated return type of UpdateUser.

Fields
Field Name Description
errorCode - String Stable machine code for the failure: the failing interaction's snake_case code (e.g. not_found, taken). Null on success. An open set, so treat an unknown code like any other failure.
errors - [String!]!
user - User
Example
{
  "errorCode": "xyz789",
  "errors": ["xyz789"],
  "user": User
}

UpdateUserPhotoPayload

Description

Autogenerated return type of UpdateUserPhoto.

Fields
Field Name Description
errors - [String!]!
userPhoto - UserPhoto
Example
{
  "errors": ["abc123"],
  "userPhoto": UserPhoto
}

UpdateUserRolesPayload

Description

Autogenerated return type of UpdateUserRoles.

Fields
Field Name Description
errors - [String!]
user - User
Example
{
  "errors": ["xyz789"],
  "user": User
}

Upload

Example
Upload

UseStreakFreezePayload

Description

Autogenerated return type of UseStreakFreeze.

Fields
Field Name Description
errors - [String!]!
goal - Goal
Example
{
  "errors": ["abc123"],
  "goal": Goal
}

User

Description

A registered Objectuve user with gamification progress, goals, and social connections.

Fields
Field Name Description
achievementStats - AchievementStats Computed rank, XP, and badge stats for the Achievements page hero.
actions - [UserAction!] Gamification action log used to compute badges and achievements, newest first. Bounded by limit — use unlockedAchievementKeys for a complete badge-unlock check independent of this limit. Viewer-or-admin only; raises FORBIDDEN for other users.
Arguments
limit - Int

Maximum number of actions to return (default 50, clamped to 200).

admin - Boolean! Whether the user has admin privileges. Viewer-or-admin only; returns false for other users.
adminRoles - [String!]! List of admin RBAC roles enabled for this user. Viewer-or-admin only; returns [] for other users.
badgeActions - [UserAction!]! Every unlocked badge action for this user, newest first (v4.123 G1) — bounded by the badge catalog, never by a limit, so a badge can never fall out of the window the way it can on actions. Viewer-or-admin only; raises FORBIDDEN for other users.
celebrationPreferences - CelebrationPreferences! How the encouragement celebration plays (v4.107). Viewer-or-admin only; returns default preferences for other users.
charterMarkerHidden - Boolean! Whether the user has hidden the charter member marker from other viewers. Defaults to false. Viewer-or-admin only; returns false for other users.
charterMemberSince - ISO8601DateTime When the account joined the charter cohort, or null if not a charter member. Also null to other viewers when the marker is hidden or the viewer cannot see this profile; the owner and admins always see the real value.
charterNotesEnabled - Boolean! Whether the user has opted in to the Charter notes email (nil defaults to false). Viewer-or-admin only; returns false for other users.
coachingPreferences - CoachingPreferences! AI Coach persona and communication preferences. Viewer-or-admin only; returns default preferences for other users.
colorTheme - String! Supporter color theme slug synced across devices. Defaults to "default". Viewer-or-admin only; returns "default" for other users.
completedCommunityChallenges - [ChallengeParticipant!]! Challenge participations where the user has met the completion threshold. For another user, only participations in community rooms the viewer can access are included (admins see all).
completedSeasonalEvents - [SeasonalEventParticipant!]! Seasonal event participations where the user has met the completion threshold. Viewer-or-admin only; returns [] for other users.
createdAtTime - String Unix timestamp (string) when the account was created. Viewer-or-admin only; returns null for other users.
currentInsights - [InsightPack!]! Daily AI coaching insight cards for the five core app pages. Returns cached packs or an empty array when the cache is cold. Never raises AI_DISABLED — callers should render fallback copy on empty array. Viewer-or-admin only; returns [] for other users.
dashboardPreferences - DashboardPreferences! Dashboard hierarchy view preferences (v4.15). Viewer-or-admin only; returns default preferences for other users.
dayClosedToday - Boolean! True when every habit scheduled for the viewer's local today (E7) carries a check-in dated today, and at least one habit was scheduled. Viewer-only; raises FORBIDDEN for other users.
daysShownUp - Int! Lifetime count of distinct days with an earned action. Excludes imported/backfilled activity and streak-freeze days. Never reset by a lapse. Viewer-or-admin only; returns 0 for other users.
daysSinceLastActive - Int Days since last recorded activity. Null for users who have never been active. Viewer-or-admin only; returns null for other users.
demo - Boolean! Whether this user is a demo-tagged record (Phase 30). Viewer-or-admin only; returns false for other users.
details - UserDetail Extended profile metadata stored as JSON (e.g. showcased achievements). Viewer-or-admin only; raises FORBIDDEN for other users.
email - String! Primary email address for the account. Viewer-or-admin only; returns a placeholder for other users.
emailVerified - Boolean! Whether the user has confirmed their email address. Viewer-or-admin only; returns false for other users.
featureTourStatus - JSON! Feature-tour completion/dismissal state, keyed by tour id (e.g. "dashboard-first-run"). Empty hash if no tour has started. Viewer-or-admin only; returns {} for other users.
feedItems - [UserFeedItem!] Personal activity feed items for the user's home timeline, newest first. Viewer-or-admin only; raises FORBIDDEN for other users.
Arguments
limit - Int

Maximum number of feed items to return (default 50, clamped to 200).

firstName - String User's given name.
goItAlone - Boolean! Whether the user has opted out of ally/community/coach-social prompts. Defaults to false. Viewer-or-admin only; returns false for other users.
goalDayContext - GoalDayContext! Server-computed today and account start date. Viewer-only.
goalDayLog - [GoalDayLogEntry!]! Every active goal scheduled or logged on one user-local day. Viewer-only; empty before the account existed.
Arguments
date - ISO8601Date!

The day (user-local, not in the future).

goalDaySummaries - [GoalDaySummary!]! One row per user-local day in from..to across the viewer's active goals. Viewer-only; the span is at most 42 days and no date may be in the future.
Arguments
from - ISO8601Date!

First day (user-local).

to - ISO8601Date!

Last day (user-local).

goalMotivationProfile - GoalMotivationProfile Goal Motivation Snapshot answers. Null until first answer is saved. Viewer-or-admin only; raises FORBIDDEN for other users.
goals - [Goal!]! All goals owned by this user. Viewer-or-admin only; returns [] for other users.
graceDays - [String!]! ISO date strings (within last 30 days) where soft-grace forgave a single-day streak gap. Forgiven days are skipped — not counted toward the streak number. Viewer-or-admin only; returns [] for other users.
hasAlly - Boolean! True if the user has at least one accepted ally (either direction). Viewer-or-admin only; returns false for other users.
hasCreatedFromTemplate - Boolean! True if the user has at least one goal created from a template. Viewer-or-admin only; returns false for other users.
hasDigestEnabled - Boolean! Whether the user has weekly digest emails enabled (nil defaults to true). Viewer-or-admin only; returns false for other users.
isSupporter - Boolean! Whether the user has an active Supporter subscription. Viewer-or-admin only; returns false for other users.
lastDigestSentAt - String ISO 8601 timestamp of the last digest sent, or null if never sent. Viewer-or-admin only; returns null for other users.
lastName - String User's family name.
latestEnneagramAssessment - EnneagramAssessment Most recent completed Enneagram assessment for this user, or null if none. Viewer-or-admin only; raises FORBIDDEN for other users.
level - Int! Current gamification level derived from XP.
longestStreak - Int! All-time longest streak of consecutive active days.
moodGoalInsight - InsightPack Reflective correlation between mood logs and goal check-ins. Null unless a correlation exists for this user.
nextLevelThreshold - Int! XP required to reach the next level.
nextOnTheShelfBadge - NextBadge The locked badge closest to being unlocked, or null if all badges are earned.
notifications - [UserNotification!] In-app notifications for this user, newest first. Viewer-or-admin only; raises FORBIDDEN for other users.
Arguments
limit - Int

Maximum number of notifications to return (default 50, clamped to 200).

onboardingStatus - OnboardingStatus v1.8 onboarding completion + resume state. Null until the first sync writes a started_at marker or the user is backfilled. May be present with only a started_at/reset marker, in which case version, completedAt, completedVia and progress are all null. Viewer-or-admin only; raises FORBIDDEN for other users.
paceSuggestion - PaceSuggestion Timeline-adjustment suggestion when a goal is consistently ahead of or behind pace. Null unless a suggestion exists.
photo - UserPhoto Profile photo for the user.
practiceInviteDismissedAt - String ISO8601 timestamp of the last "Not now" on the Today zero-habit invitation (v4.93 Phase 4, OBJ-5448); null before any dismissal. The invitation re-shows 7 days after this. Viewer-or-admin only; returns null for other users.
privateMode - Boolean! Whether the user is hidden from username search. Defaults to false. Viewer-or-admin only; returns false for other users.
progressToNextLevel - Float! Fraction (0.0–1.0) representing progress toward the next level.
publicId - ID! URL-safe public identifier. Use this for all lookups — internal integer IDs are never exposed.
recentlyUnlockedBadges - [RecentlyUnlockedBadge!]! Badges unlocked within the specified window, newest first.
Arguments
limit - Int

Maximum number of badges to return.

sinceDays - Int

How many days back to look for recently unlocked badges.

requiredCheckinsCompleteToday - Boolean! True when the user has logged every habit check-in expected today (or has no habits expected today). Viewer-or-admin only; returns false for other users.
reverseNudge - ReverseNudge One-time reverse-nudge for a habit-only user (v4.93 Phase 6, OBJ-5453): names the earliest-created eligible habit for the Dashboard card asking what it's building toward. Null when ineligible, already shown, or the flag is off. Viewer-or-admin only; returns null for other users.
showcasedAchievements - [String!] Achievement identifiers the user has chosen to display on their profile.
signInDates - [String!] ISO dates that count toward the streak (activity days; sign-ins don't count).
signupAgeDays - Int! Whole days since the user account was created (signup age).
stats - UserStats Aggregated goal and achievement statistics for the user. Viewer-or-admin only; raises FORBIDDEN for other users.
streak - Int! Current number of consecutive days the user has logged activity.
streakJourney - StreakJourney The current streak as a journey. Self only, null for anyone else.
streakRecountNotePending - Boolean! True once the one-time earned-only streak recount (OBJ-4243) changed this user's current_streak or longest_streak and the in-modal note has not yet been acknowledged. Viewer-or-admin only; returns false for other users.
streakRepairOffer - StreakRepairOffer Streak Repair eligibility and offer payload for the active-user repair window. Viewer-or-admin only; returns null for other users.
streakRescueDays - [StreakRescueDay!]! Days in the last 7 a freeze or repair kept in the streak, with the kind. Viewer-only — empty for any other user.
supporterCancelAtPeriodEnd - Boolean! Whether the Supporter subscription is set to end at the current period (no further renewal). Viewer-or-admin only; returns false for other users.
supporterMoments - SupporterMoments Seen-state and mute flag for in-app supporter moments (v4.96 Phase 1.3, OBJ-5560). Viewer-or-admin only; returns null for other users.
supporterTier - String Active supporter tier: monthly, yearly, lifetime, or null. Viewer-or-admin only; returns null for other users.
supporterUntil - ISO8601DateTime When the current supporter period ends (null for lifetime). Viewer-or-admin only; raises FORBIDDEN for other users.
timeToFirstGoalSeconds - Int Seconds from account creation to first (non-deleted) goal. Admin-only — returns null for non-admin viewers.
todaysMood - String Most recent mood log from today, or null if not logged. Viewer-or-admin only; raises FORBIDDEN for other users.
unlockedAchievementKeys - [String!]! Distinct set of gamification action keys this user has ever unlocked, independent of the actions field limit. Use this for badge-unlock checks instead of scanning actions. Viewer-or-admin only; returns [] for other users.
updatedAtTime - String Unix timestamp (string) when the account was last updated. Viewer-or-admin only; returns null for other users.
username - String Unique handle chosen by the user (e.g. "jane.doe").
welcomeBackOffer - WelcomeBackOffer Streak Mercy eligibility and offer payload. Null until user is synced. Viewer-or-admin only; returns null for other users.
xp - Int! Total experience points earned through goals, events, and engagement.
Example
{
  "achievementStats": AchievementStats,
  "actions": [UserAction],
  "admin": true,
  "adminRoles": ["xyz789"],
  "badgeActions": [UserAction],
  "celebrationPreferences": CelebrationPreferences,
  "charterMarkerHidden": false,
  "charterMemberSince": ISO8601DateTime,
  "charterNotesEnabled": true,
  "coachingPreferences": CoachingPreferences,
  "colorTheme": "abc123",
  "completedCommunityChallenges": [ChallengeParticipant],
  "completedSeasonalEvents": [SeasonalEventParticipant],
  "createdAtTime": "abc123",
  "currentInsights": [InsightPack],
  "dashboardPreferences": DashboardPreferences,
  "dayClosedToday": true,
  "daysShownUp": 123,
  "daysSinceLastActive": 123,
  "demo": false,
  "details": UserDetail,
  "email": "abc123",
  "emailVerified": true,
  "featureTourStatus": {},
  "feedItems": [UserFeedItem],
  "firstName": "xyz789",
  "goItAlone": false,
  "goalDayContext": GoalDayContext,
  "goalDayLog": [GoalDayLogEntry],
  "goalDaySummaries": [GoalDaySummary],
  "goalMotivationProfile": GoalMotivationProfile,
  "goals": [Goal],
  "graceDays": ["abc123"],
  "hasAlly": false,
  "hasCreatedFromTemplate": true,
  "hasDigestEnabled": false,
  "isSupporter": true,
  "lastDigestSentAt": "abc123",
  "lastName": "xyz789",
  "latestEnneagramAssessment": EnneagramAssessment,
  "level": 987,
  "longestStreak": 987,
  "moodGoalInsight": InsightPack,
  "nextLevelThreshold": 123,
  "nextOnTheShelfBadge": NextBadge,
  "notifications": [UserNotification],
  "onboardingStatus": OnboardingStatus,
  "paceSuggestion": PaceSuggestion,
  "photo": UserPhoto,
  "practiceInviteDismissedAt": "abc123",
  "privateMode": false,
  "progressToNextLevel": 987.65,
  "publicId": 4,
  "recentlyUnlockedBadges": [RecentlyUnlockedBadge],
  "requiredCheckinsCompleteToday": false,
  "reverseNudge": ReverseNudge,
  "showcasedAchievements": ["xyz789"],
  "signInDates": ["xyz789"],
  "signupAgeDays": 123,
  "stats": UserStats,
  "streak": 123,
  "streakJourney": StreakJourney,
  "streakRecountNotePending": false,
  "streakRepairOffer": StreakRepairOffer,
  "streakRescueDays": [StreakRescueDay],
  "supporterCancelAtPeriodEnd": true,
  "supporterMoments": SupporterMoments,
  "supporterTier": "xyz789",
  "supporterUntil": ISO8601DateTime,
  "timeToFirstGoalSeconds": 987,
  "todaysMood": "abc123",
  "unlockedAchievementKeys": ["abc123"],
  "updatedAtTime": "abc123",
  "username": "xyz789",
  "welcomeBackOffer": WelcomeBackOffer,
  "xp": 123
}

UserAction

Description

A gamification action record tracking user behaviour for badges and achievements.

Fields
Field Name Description
acknowledged - Boolean! Whether the user has been shown/dismissed the reward for this action.
action - String! Action identifier (e.g. "goal_created", "streak_7", "encouragement_given").
communityName - String For community-scoped badges, the name of the community the badge was earned in.
createdAtTime - String Unix timestamp (string) when this action was recorded.
id - ID! Public identifier for this action record.
source - BadgeSource Where this badge came from, when a source was recorded for it (v4.123). Null means no source was recorded — a normal state.
Example
{
  "acknowledged": false,
  "action": "abc123",
  "communityName": "abc123",
  "createdAtTime": "abc123",
  "id": 4,
  "source": BadgeSource
}

UserActivity

Description

A single activity item in a user activity timeline within a community context.

Fields
Field Name Description
communityId - ID public_id of the community this activity is associated with, if any.
communityName - String Name of the community this activity is associated with, if any.
content - String! Human-readable description of the activity.
id - ID! Public identifier for this activity item.
timestamp - String! Unix timestamp (string) when this activity occurred.
type - String! Activity type (e.g. "goal_event", "community_post", "milestone_completed").
Example
{
  "communityId": 4,
  "communityName": "abc123",
  "content": "abc123",
  "id": "4",
  "timestamp": "abc123",
  "type": "abc123"
}

UserAlly

Description

A friend/ally connection — another user in the current user allies network.

Fields
Field Name Description
accountabilityPartner - Boolean! Whether this ally is the current accountability partner.
accountabilityPartnerSince - ISO8601DateTime When the partnership was established.
checkedInToday - Boolean! Whether this ally has checked in on a habit today in their own time zone. Counts only check-ins on goals visible to the viewer through ally activity; false for anyone who is not an accepted, unblocked ally.
createdAtTime - String Request creation time as unix epoch seconds (string).
firstName - String The ally user's given name.
id - ID! Public identifier for this ally relationship record.
lastName - String The ally user's family name.
mutualCount - Int! Number of mutual allies shared between the current user and this ally.
mutualStreakCount - Int! Current mutual check-in streak count.
partnerRequestedByMe - Boolean! Whether the current user sent the pending partner request.
partnerStatus - String! Partnership state: "none", "pending", or "active".
photo - UserPhoto The ally user's profile photo.
publicId - String! URL-safe public identifier of the ally user.
status - String Raw ally relationship status: "pending", "accepted", or "blocked".
user - PendingAllyUser The requesting user for a pending ally request.
username - String The ally user's unique handle.
Example
{
  "accountabilityPartner": true,
  "accountabilityPartnerSince": ISO8601DateTime,
  "checkedInToday": true,
  "createdAtTime": "xyz789",
  "firstName": "xyz789",
  "id": "4",
  "lastName": "abc123",
  "mutualCount": 123,
  "mutualStreakCount": 987,
  "partnerRequestedByMe": true,
  "partnerStatus": "xyz789",
  "photo": UserPhoto,
  "publicId": "xyz789",
  "status": "abc123",
  "user": PendingAllyUser,
  "username": "abc123"
}

UserConnection

Description

The connection type for User.

Fields
Field Name Description
edges - [UserEdge] A list of edges.
nodes - [User] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [UserEdge],
  "nodes": [User],
  "pageInfo": PageInfo
}

UserDetail

Description

Extended profile metadata for a user, stored as a JSON blob.

Fields
Field Name Description
coachPickerDeferred - Boolean! Whether the user chose "Decide later" on the empty-dashboard Coach picker.
coachWarmupCompleted - Boolean! Whether the user has completed the Coach cold-start warmup (coach_warmup_context is present).
coachWarmupDismissed - Boolean! Whether the user has dismissed the Coach cold-start warmup sheet via "Skip for now" (OBJ-4894).
dashboardFocusIntroDismissed - Boolean! Whether the Focus intro card has been dismissed or Focus has been opened at least once (v4.111).
dashboardMigratedFromFull - Boolean! Whether this user was backfilled from the legacy "full" dashboard mode to Detailed (v4.15).
dashboardMigrationNoteDismissed - Boolean! Whether the dashboard hierarchy migration note has been dismissed (v4.15).
dashboardRelocationHintAchieveDismissed - Boolean! Whether the ShowcasedAchievements → Achieve relocation hint has been dismissed (v4.15). Deprecated. Retired with the v4.15 dashboard hierarchy (261011-n5l); the app no longer reads it (OBJ-4388).
dashboardRelocationHintCommunityDismissed - Boolean! Whether the SocialSection → Community relocation hint has been dismissed (v4.15). Deprecated. Retired with the v4.15 dashboard hierarchy (261011-n5l); the app no longer reads it (OBJ-4388).
data - String! JSON string containing arbitrary profile metadata (e.g. showcasedAchievements, onboarding state).
enneagramCardDismissed - Boolean! Whether the user has permanently dismissed the Enneagram dashboard prompt card.
id - ID! Public identifier for this detail record.
Example
{
  "coachPickerDeferred": false,
  "coachWarmupCompleted": true,
  "coachWarmupDismissed": false,
  "dashboardFocusIntroDismissed": false,
  "dashboardMigratedFromFull": true,
  "dashboardMigrationNoteDismissed": false,
  "dashboardRelocationHintAchieveDismissed": false,
  "dashboardRelocationHintCommunityDismissed": false,
  "data": "xyz789",
  "enneagramCardDismissed": false,
  "id": "4"
}

UserEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - User The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": User
}

UserFeedItem

Description

A single item in the user personal activity feed (home timeline).

Fields
Field Name Description
content - String! Human-readable text describing the feed event.
createdAtTime - String Unix timestamp (string) when this feed item was created.
detailsJson - String! JSON string with additional event metadata (e.g. related goal ID, user ID).
id - ID! Public identifier for this feed item.
kind - String! Feed item type (e.g. "goal_event", "encouragement_received", "milestone_completed").
Example
{
  "content": "abc123",
  "createdAtTime": "xyz789",
  "detailsJson": "abc123",
  "id": 4,
  "kind": "abc123"
}

UserNotification

Description

An in-app notification delivered to a user.

Fields
Field Name Description
acknowledged - Boolean! Whether the user has dismissed/read this notification.
content - String! Human-readable notification message.
createdAtTime - String Unix timestamp (string) when this notification was created.
detailsJson - String! JSON string with additional metadata (e.g. source user ID, goal ID).
id - ID! Public identifier for this notification.
kind - String! Notification category (e.g. "encouragement", "milestone_completed", "community_post").
Example
{
  "acknowledged": false,
  "content": "xyz789",
  "createdAtTime": "abc123",
  "detailsJson": "abc123",
  "id": 4,
  "kind": "abc123"
}

UserPhoto

Description

A profile photo associated with a user.

Fields
Field Name Description
id - ID! Public identifier for this photo record.
imageUrl - String URL of the profile photo image.
Example
{"id": 4, "imageUrl": "xyz789"}

UserSearchResult

Description

A user returned from the user-facing searchUsers query, with per-result ally relationship status.

Fields
Field Name Description
achievementStats - AchievementStats Computed rank, XP, and badge stats for the Achievements page hero.
actions - [UserAction!] Gamification action log used to compute badges and achievements, newest first. Bounded by limit — use unlockedAchievementKeys for a complete badge-unlock check independent of this limit. Viewer-or-admin only; raises FORBIDDEN for other users.
Arguments
limit - Int

Maximum number of actions to return (default 50, clamped to 200).

admin - Boolean! Whether the user has admin privileges. Viewer-or-admin only; returns false for other users.
adminRoles - [String!]! List of admin RBAC roles enabled for this user. Viewer-or-admin only; returns [] for other users.
allyStatus - AllyStatusEnum! Relationship status between the authenticated user and this search result.
badgeActions - [UserAction!]! Every unlocked badge action for this user, newest first (v4.123 G1) — bounded by the badge catalog, never by a limit, so a badge can never fall out of the window the way it can on actions. Viewer-or-admin only; raises FORBIDDEN for other users.
celebrationPreferences - CelebrationPreferences! How the encouragement celebration plays (v4.107). Viewer-or-admin only; returns default preferences for other users.
charterMarkerHidden - Boolean! Whether the user has hidden the charter member marker from other viewers. Defaults to false. Viewer-or-admin only; returns false for other users.
charterMemberSince - ISO8601DateTime When the account joined the charter cohort, or null if not a charter member. Also null to other viewers when the marker is hidden or the viewer cannot see this profile; the owner and admins always see the real value.
charterNotesEnabled - Boolean! Whether the user has opted in to the Charter notes email (nil defaults to false). Viewer-or-admin only; returns false for other users.
coachingPreferences - CoachingPreferences! AI Coach persona and communication preferences. Viewer-or-admin only; returns default preferences for other users.
colorTheme - String! Supporter color theme slug synced across devices. Defaults to "default". Viewer-or-admin only; returns "default" for other users.
completedCommunityChallenges - [ChallengeParticipant!]! Challenge participations where the user has met the completion threshold. For another user, only participations in community rooms the viewer can access are included (admins see all).
completedSeasonalEvents - [SeasonalEventParticipant!]! Seasonal event participations where the user has met the completion threshold. Viewer-or-admin only; returns [] for other users.
createdAtTime - String Unix timestamp (string) when the account was created. Viewer-or-admin only; returns null for other users.
currentInsights - [InsightPack!]! Daily AI coaching insight cards for the five core app pages. Returns cached packs or an empty array when the cache is cold. Never raises AI_DISABLED — callers should render fallback copy on empty array. Viewer-or-admin only; returns [] for other users.
dashboardPreferences - DashboardPreferences! Dashboard hierarchy view preferences (v4.15). Viewer-or-admin only; returns default preferences for other users.
dayClosedToday - Boolean! True when every habit scheduled for the viewer's local today (E7) carries a check-in dated today, and at least one habit was scheduled. Viewer-only; raises FORBIDDEN for other users.
daysShownUp - Int! Lifetime count of distinct days with an earned action. Excludes imported/backfilled activity and streak-freeze days. Never reset by a lapse. Viewer-or-admin only; returns 0 for other users.
daysSinceLastActive - Int Days since last recorded activity. Null for users who have never been active. Viewer-or-admin only; returns null for other users.
demo - Boolean! Whether this user is a demo-tagged record (Phase 30). Viewer-or-admin only; returns false for other users.
details - UserDetail Extended profile metadata stored as JSON (e.g. showcased achievements). Viewer-or-admin only; raises FORBIDDEN for other users.
email - String! Primary email address for the account. Viewer-or-admin only; returns a placeholder for other users.
emailVerified - Boolean! Whether the user has confirmed their email address. Viewer-or-admin only; returns false for other users.
featureTourStatus - JSON! Feature-tour completion/dismissal state, keyed by tour id (e.g. "dashboard-first-run"). Empty hash if no tour has started. Viewer-or-admin only; returns {} for other users.
feedItems - [UserFeedItem!] Personal activity feed items for the user's home timeline, newest first. Viewer-or-admin only; raises FORBIDDEN for other users.
Arguments
limit - Int

Maximum number of feed items to return (default 50, clamped to 200).

firstName - String User's given name.
goItAlone - Boolean! Whether the user has opted out of ally/community/coach-social prompts. Defaults to false. Viewer-or-admin only; returns false for other users.
goalDayContext - GoalDayContext! Server-computed today and account start date. Viewer-only.
goalDayLog - [GoalDayLogEntry!]! Every active goal scheduled or logged on one user-local day. Viewer-only; empty before the account existed.
Arguments
date - ISO8601Date!

The day (user-local, not in the future).

goalDaySummaries - [GoalDaySummary!]! One row per user-local day in from..to across the viewer's active goals. Viewer-only; the span is at most 42 days and no date may be in the future.
Arguments
from - ISO8601Date!

First day (user-local).

to - ISO8601Date!

Last day (user-local).

goalMotivationProfile - GoalMotivationProfile Goal Motivation Snapshot answers. Null until first answer is saved. Viewer-or-admin only; raises FORBIDDEN for other users.
goals - [Goal!]! All goals owned by this user. Viewer-or-admin only; returns [] for other users.
graceDays - [String!]! ISO date strings (within last 30 days) where soft-grace forgave a single-day streak gap. Forgiven days are skipped — not counted toward the streak number. Viewer-or-admin only; returns [] for other users.
hasAlly - Boolean! True if the user has at least one accepted ally (either direction). Viewer-or-admin only; returns false for other users.
hasCreatedFromTemplate - Boolean! True if the user has at least one goal created from a template. Viewer-or-admin only; returns false for other users.
hasDigestEnabled - Boolean! Whether the user has weekly digest emails enabled (nil defaults to true). Viewer-or-admin only; returns false for other users.
isSupporter - Boolean! Whether the user has an active Supporter subscription. Viewer-or-admin only; returns false for other users.
lastDigestSentAt - String ISO 8601 timestamp of the last digest sent, or null if never sent. Viewer-or-admin only; returns null for other users.
lastName - String User's family name.
latestEnneagramAssessment - EnneagramAssessment Most recent completed Enneagram assessment for this user, or null if none. Viewer-or-admin only; raises FORBIDDEN for other users.
level - Int! Current gamification level derived from XP.
longestStreak - Int! All-time longest streak of consecutive active days.
moodGoalInsight - InsightPack Reflective correlation between mood logs and goal check-ins. Null unless a correlation exists for this user.
nextLevelThreshold - Int! XP required to reach the next level.
nextOnTheShelfBadge - NextBadge The locked badge closest to being unlocked, or null if all badges are earned.
notifications - [UserNotification!] In-app notifications for this user, newest first. Viewer-or-admin only; raises FORBIDDEN for other users.
Arguments
limit - Int

Maximum number of notifications to return (default 50, clamped to 200).

onboardingStatus - OnboardingStatus v1.8 onboarding completion + resume state. Null until the first sync writes a started_at marker or the user is backfilled. May be present with only a started_at/reset marker, in which case version, completedAt, completedVia and progress are all null. Viewer-or-admin only; raises FORBIDDEN for other users.
paceSuggestion - PaceSuggestion Timeline-adjustment suggestion when a goal is consistently ahead of or behind pace. Null unless a suggestion exists.
photo - UserPhoto Profile photo for the user.
practiceInviteDismissedAt - String ISO8601 timestamp of the last "Not now" on the Today zero-habit invitation (v4.93 Phase 4, OBJ-5448); null before any dismissal. The invitation re-shows 7 days after this. Viewer-or-admin only; returns null for other users.
privateMode - Boolean! Whether the user is hidden from username search. Defaults to false. Viewer-or-admin only; returns false for other users.
progressToNextLevel - Float! Fraction (0.0–1.0) representing progress toward the next level.
publicId - ID! URL-safe public identifier. Use this for all lookups — internal integer IDs are never exposed.
recentlyUnlockedBadges - [RecentlyUnlockedBadge!]! Badges unlocked within the specified window, newest first.
Arguments
limit - Int

Maximum number of badges to return.

sinceDays - Int

How many days back to look for recently unlocked badges.

requiredCheckinsCompleteToday - Boolean! True when the user has logged every habit check-in expected today (or has no habits expected today). Viewer-or-admin only; returns false for other users.
reverseNudge - ReverseNudge One-time reverse-nudge for a habit-only user (v4.93 Phase 6, OBJ-5453): names the earliest-created eligible habit for the Dashboard card asking what it's building toward. Null when ineligible, already shown, or the flag is off. Viewer-or-admin only; returns null for other users.
showcasedAchievements - [String!] Achievement identifiers the user has chosen to display on their profile.
signInDates - [String!] ISO dates that count toward the streak (activity days; sign-ins don't count).
signupAgeDays - Int! Whole days since the user account was created (signup age).
stats - UserStats Aggregated goal and achievement statistics for the user. Viewer-or-admin only; raises FORBIDDEN for other users.
streak - Int! Current number of consecutive days the user has logged activity.
streakJourney - StreakJourney The current streak as a journey. Self only, null for anyone else.
streakRecountNotePending - Boolean! True once the one-time earned-only streak recount (OBJ-4243) changed this user's current_streak or longest_streak and the in-modal note has not yet been acknowledged. Viewer-or-admin only; returns false for other users.
streakRepairOffer - StreakRepairOffer Streak Repair eligibility and offer payload for the active-user repair window. Viewer-or-admin only; returns null for other users.
streakRescueDays - [StreakRescueDay!]! Days in the last 7 a freeze or repair kept in the streak, with the kind. Viewer-only — empty for any other user.
supporterCancelAtPeriodEnd - Boolean! Whether the Supporter subscription is set to end at the current period (no further renewal). Viewer-or-admin only; returns false for other users.
supporterMoments - SupporterMoments Seen-state and mute flag for in-app supporter moments (v4.96 Phase 1.3, OBJ-5560). Viewer-or-admin only; returns null for other users.
supporterTier - String Active supporter tier: monthly, yearly, lifetime, or null. Viewer-or-admin only; returns null for other users.
supporterUntil - ISO8601DateTime When the current supporter period ends (null for lifetime). Viewer-or-admin only; raises FORBIDDEN for other users.
timeToFirstGoalSeconds - Int Seconds from account creation to first (non-deleted) goal. Admin-only — returns null for non-admin viewers.
todaysMood - String Most recent mood log from today, or null if not logged. Viewer-or-admin only; raises FORBIDDEN for other users.
unlockedAchievementKeys - [String!]! Distinct set of gamification action keys this user has ever unlocked, independent of the actions field limit. Use this for badge-unlock checks instead of scanning actions. Viewer-or-admin only; returns [] for other users.
updatedAtTime - String Unix timestamp (string) when the account was last updated. Viewer-or-admin only; returns null for other users.
username - String Unique handle chosen by the user (e.g. "jane.doe").
welcomeBackOffer - WelcomeBackOffer Streak Mercy eligibility and offer payload. Null until user is synced. Viewer-or-admin only; returns null for other users.
xp - Int! Total experience points earned through goals, events, and engagement.
Example
{
  "achievementStats": AchievementStats,
  "actions": [UserAction],
  "admin": true,
  "adminRoles": ["abc123"],
  "allyStatus": "ACCEPTED",
  "badgeActions": [UserAction],
  "celebrationPreferences": CelebrationPreferences,
  "charterMarkerHidden": true,
  "charterMemberSince": ISO8601DateTime,
  "charterNotesEnabled": true,
  "coachingPreferences": CoachingPreferences,
  "colorTheme": "xyz789",
  "completedCommunityChallenges": [ChallengeParticipant],
  "completedSeasonalEvents": [SeasonalEventParticipant],
  "createdAtTime": "xyz789",
  "currentInsights": [InsightPack],
  "dashboardPreferences": DashboardPreferences,
  "dayClosedToday": true,
  "daysShownUp": 123,
  "daysSinceLastActive": 987,
  "demo": false,
  "details": UserDetail,
  "email": "abc123",
  "emailVerified": false,
  "featureTourStatus": {},
  "feedItems": [UserFeedItem],
  "firstName": "abc123",
  "goItAlone": true,
  "goalDayContext": GoalDayContext,
  "goalDayLog": [GoalDayLogEntry],
  "goalDaySummaries": [GoalDaySummary],
  "goalMotivationProfile": GoalMotivationProfile,
  "goals": [Goal],
  "graceDays": ["xyz789"],
  "hasAlly": true,
  "hasCreatedFromTemplate": true,
  "hasDigestEnabled": false,
  "isSupporter": false,
  "lastDigestSentAt": "abc123",
  "lastName": "xyz789",
  "latestEnneagramAssessment": EnneagramAssessment,
  "level": 987,
  "longestStreak": 987,
  "moodGoalInsight": InsightPack,
  "nextLevelThreshold": 987,
  "nextOnTheShelfBadge": NextBadge,
  "notifications": [UserNotification],
  "onboardingStatus": OnboardingStatus,
  "paceSuggestion": PaceSuggestion,
  "photo": UserPhoto,
  "practiceInviteDismissedAt": "abc123",
  "privateMode": true,
  "progressToNextLevel": 123.45,
  "publicId": 4,
  "recentlyUnlockedBadges": [RecentlyUnlockedBadge],
  "requiredCheckinsCompleteToday": false,
  "reverseNudge": ReverseNudge,
  "showcasedAchievements": ["abc123"],
  "signInDates": ["abc123"],
  "signupAgeDays": 123,
  "stats": UserStats,
  "streak": 123,
  "streakJourney": StreakJourney,
  "streakRecountNotePending": true,
  "streakRepairOffer": StreakRepairOffer,
  "streakRescueDays": [StreakRescueDay],
  "supporterCancelAtPeriodEnd": true,
  "supporterMoments": SupporterMoments,
  "supporterTier": "abc123",
  "supporterUntil": ISO8601DateTime,
  "timeToFirstGoalSeconds": 987,
  "todaysMood": "xyz789",
  "unlockedAchievementKeys": ["xyz789"],
  "updatedAtTime": "abc123",
  "username": "xyz789",
  "welcomeBackOffer": WelcomeBackOffer,
  "xp": 123
}

UserSearchResultConnection

Description

The connection type for UserSearchResult.

Fields
Field Name Description
edges - [UserSearchResultEdge] A list of edges.
nodes - [UserSearchResult] A list of nodes.
pageInfo - PageInfo! Information to aid in pagination.
Example
{
  "edges": [UserSearchResultEdge],
  "nodes": [UserSearchResult],
  "pageInfo": PageInfo
}

UserSearchResultEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - UserSearchResult The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": UserSearchResult
}

UserStats

Description

Aggregated goal and achievement statistics for a user.

Fields
Field Name Description
categoriesUsed - [String!]! List of goal category names the user has set goals in.
completedGoals - Int! Number of goals the user has marked as completed.
encouragementsGiven - Int! Number of encouragements the user has sent to other users.
goalsCreatedCount - Int! Count of goals created (may differ from total_goals based on scope).
milestonesCompleted - Int! Number of milestones the user has completed.
milestonesCreated - Int! Number of milestone sub-goals the user has created.
totalGoals - Int! Total number of goals created by the user (including completed and deleted).
typesUsed - [String!]! List of goal type names the user has used.
Example
{
  "categoriesUsed": ["abc123"],
  "completedGoals": 987,
  "encouragementsGiven": 123,
  "goalsCreatedCount": 987,
  "milestonesCompleted": 123,
  "milestonesCreated": 987,
  "totalGoals": 123,
  "typesUsed": ["abc123"]
}

VerifyMagicCodePayload

Description

Autogenerated return type of VerifyMagicCode.

Fields
Field Name Description
errors - [String!]!
token - String
user - User
Example
{
  "errors": ["xyz789"],
  "token": "abc123",
  "user": User
}

WeeklyDigestPreferences

Description

Weekly digest email preferences for the authenticated user.

Fields
Field Name Description
deliveryDay - String! Day to deliver the digest: 'sun', 'sat', or 'mon'. Defaults to 'sun'.
enabled - Boolean! Whether the user has opted into the weekly digest.
Example
{"deliveryDay": "abc123", "enabled": false}

WelcomeBackOffer

Description

Streak Mercy offer shown to users returning after 5+ days away.

Fields
Field Name Description
coachCopy - String AI Coach message for the interstitial. Null when ineligible.
daysSinceLastActive - Int Days since the user last recorded activity.
eligible - Boolean! Whether the user qualifies for a Streak Mercy offer right now.
notificationPublicId - ID public_id of the UserNotification backing this offer — pass to acknowledgeNotification to dismiss it server-side. Null when ineligible.
targetGoalName - String Name of the target habit goal. Null when ineligible.
targetGoalPublicId - ID public_id of the habit goal eligible for Streak Mercy. Null when ineligible.
targetHabitStreak - Int Pre-break habit streak snapshot (captured before zeroing). Headline number in the Welcome Back interstitial. Null when ineligible.
Example
{
  "coachCopy": "abc123",
  "daysSinceLastActive": 987,
  "eligible": false,
  "notificationPublicId": "4",
  "targetGoalName": "xyz789",
  "targetGoalPublicId": 4,
  "targetHabitStreak": 987
}

WelcomeSeriesPreferences

Description

Welcome series email preferences for the authenticated user.

Fields
Field Name Description
enabled - Boolean! Whether the user has opted into the welcome series.
Example
{"enabled": true}

WithdrawEncouragementPayload

Description

Autogenerated return type of WithdrawEncouragement.

Fields
Field Name Description
encouragement - Encouragement
errorCode - String Stable machine code for the failure: the failing interaction's snake_case code (e.g. not_found, taken). Null on success. An open set, so treat an unknown code like any other failure.
errors - [String!]!
Example
{
  "encouragement": Encouragement,
  "errorCode": "xyz789",
  "errors": ["xyz789"]
}

WordCloud

Description

A word and its frequency count, used for admin word cloud analytics.

Fields
Field Name Description
name - String! The word or token extracted from the data.
value - Int! Frequency count — how many times this word appears in the dataset.
Example
{"name": "xyz789", "value": 987}