Goals

get_goals

Get list of goals for the authenticated user's organization

get_goals

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_goals",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "level": "ORGANIZATION",
        "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
        "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
        "status": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_goals",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "level": "ORGANIZATION",
    "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
    "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "string"
  }
});

result = await session.call_tool("get_goals", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "level": "ORGANIZATION",
  "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
  "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "string"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for goal name or description

relationsArray<string>

Relations to include (e.g., ["ownerTeam", "ownerEmployee", "keyResults"])

levelstringORGANIZATIONTEAMEMPLOYEE

Filter by goal level

ownerEmployeeIdstring<uuid>

Filter by owner employee ID

ownerTeamIdstring<uuid>

Filter by owner team ID

statusstring

Filter by goal status

get_goal_count

Get goal count in the authenticated user's organization

get_goal_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_goal_count",
    "arguments": {
        "level": "ORGANIZATION",
        "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
        "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
        "status": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_goal_count",
  "arguments": {
    "level": "ORGANIZATION",
    "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
    "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "string"
  }
});

result = await session.call_tool("get_goal_count", arguments={
  "level": "ORGANIZATION",
  "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
  "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "string"
})

Parameters

levelstringORGANIZATIONTEAMEMPLOYEE

Filter by goal level

ownerEmployeeIdstring<uuid>

Filter by owner employee ID

ownerTeamIdstring<uuid>

Filter by owner team ID

statusstring

Filter by goal status

get_goal

Get a specific goal by ID

get_goal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_goal",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_goal",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_goal", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The goal ID

relationsArray<string>

Relations to include (e.g., ["ownerTeam", "ownerEmployee", "keyResults", "alignedGoals"])

create_goal

Create a new goal in the authenticated user's organization

create_goal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_goal",
    "arguments": {
        "goal_data": {
          "name": "string",
          "deadline": "string",
          "level": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_goal",
  "arguments": {
    "goal_data": {
      "name": "string",
      "deadline": "string",
      "level": "string"
    }
  }
});

result = await session.call_tool("create_goal", arguments={
  "goal_data": {
    "name": "string",
    "deadline": "string",
    "level": "string"
  }
})

Request Body

{
  "goal_data": {
    "name": "string",
    "deadline": "string",
    "level": "string"
  }
}

Body

application/json

goal_dataobjectrequired

The data for creating the goal

Show child attributes

namestringrequired

The goal name (required)

deadlinestringrequired

The deadline (required)

levelstringrequired

The level (required)

[key: string]any

update_goal

Update an existing goal

update_goal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_goal",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "goal_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_goal",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "goal_data": {}
  }
});

result = await session.call_tool("update_goal", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "goal_data": {}
})

Parameters

idstring<uuid>required

The goal ID

goal_dataobjectrequired

The data for updating the goal

update_goal_progress

Update the progress of a goal

update_goal_progress

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_goal_progress",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "progress": 0
      }
  }
}

const result = await client.callTool({
  "name": "update_goal_progress",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "progress": 0
  }
});

result = await session.call_tool("update_goal_progress", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "progress": 0
})

Parameters

idstring<uuid>required

The goal ID

progressnumber[0, 100]required

The progress percentage (0-100)

delete_goal

Delete a goal

delete_goal

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_goal",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_goal",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_goal", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The goal ID

get_my_goals

Get goals assigned to the current authenticated user

get_my_goals

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_my_goals",
    "arguments": {
        "page": 1,
        "limit": 10,
        "level": "ORGANIZATION",
        "status": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_my_goals",
  "arguments": {
    "page": 1,
    "limit": 10,
    "level": "ORGANIZATION",
    "status": "string"
  }
});

result = await session.call_tool("get_my_goals", arguments={
  "page": 1,
  "limit": 10,
  "level": "ORGANIZATION",
  "status": "string"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

levelstringORGANIZATIONTEAMEMPLOYEE

Filter by goal level

statusstring

Filter by goal status

get_team_goals

Get goals for a specific team

get_team_goals

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_team_goals",
    "arguments": {
        "teamId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "status": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_team_goals",
  "arguments": {
    "teamId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "status": "string"
  }
});

result = await session.call_tool("get_team_goals", arguments={
  "teamId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "status": "string"
})

Parameters

teamIdstring<uuid>required

The team ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

statusstring

Filter by goal status

get_goal_statistics

Get goal statistics for the authenticated user's organization

get_goal_statistics

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_goal_statistics",
    "arguments": {
        "level": "ORGANIZATION",
        "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
        "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
        "startDate": "string",
        "endDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_goal_statistics",
  "arguments": {
    "level": "ORGANIZATION",
    "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
    "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
    "startDate": "string",
    "endDate": "string"
  }
});

result = await session.call_tool("get_goal_statistics", arguments={
  "level": "ORGANIZATION",
  "ownerEmployeeId": "550e8400-e29b-41d4-a716-446655440000",
  "ownerTeamId": "550e8400-e29b-41d4-a716-446655440000",
  "startDate": "string",
  "endDate": "string"
})

Parameters

levelstringORGANIZATIONTEAMEMPLOYEE

Filter by goal level

ownerEmployeeIdstring<uuid>

Filter by owner employee ID

ownerTeamIdstring<uuid>

Filter by owner team ID

startDatestring

Start date for goal statistics (ISO format)

endDatestring

End date for goal statistics (ISO format)

align_goals

Align one goal with another (create goal alignment)

align_goals

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "align_goals",
    "arguments": {
        "parentGoalId": "550e8400-e29b-41d4-a716-446655440000",
        "childGoalId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "align_goals",
  "arguments": {
    "parentGoalId": "550e8400-e29b-41d4-a716-446655440000",
    "childGoalId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("align_goals", arguments={
  "parentGoalId": "550e8400-e29b-41d4-a716-446655440000",
  "childGoalId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

parentGoalIdstring<uuid>required

The parent goal ID

childGoalIdstring<uuid>required

The child goal ID to align with parent

get_goal_templates

Get goal templates for the authenticated user's organization

get_goal_templates

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_goal_templates",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "level": "ORGANIZATION"
      }
  }
}

const result = await client.callTool({
  "name": "get_goal_templates",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "level": "ORGANIZATION"
  }
});

result = await session.call_tool("get_goal_templates", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "level": "ORGANIZATION"
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for template name

levelstringORGANIZATIONTEAMEMPLOYEE

Filter by goal level

Stack Overflow Website Demo