← Tools Reference

Workpath

Workpath integration (Productivity). Imported from open-connector.

API key8 toolshttps://connect.workpath.com/api/v3
GET
workpath_list_goals
List Workpath goals visible to the API client, optionally filtered by an overlapping date range.

/goals

3 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe Workpath page number to request. Workpath returns the first page when omitt…
startDatestringoptionalReturn goals whose start and target dates overlap this start date. Must be pass…
endDatestringoptionalReturn goals whose start and target dates overlap this end date. Must be passed…
GET
workpath_get_goal
Get one Workpath goal by its unique identifier.

/goals/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe unique Workpath goal identifier.
GET
workpath_list_goal_key_results
List all key results associated with a specific Workpath goal.

/goals/{goalId}/key_results

1 parameter
ParamTypeRequiredDescription
goalIdintegerrequiredThe unique Workpath goal identifier.
GET
workpath_get_goal_key_result
Get one Workpath key result by its unique identifier using the official convenience endpoint.

/key_results/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe unique Workpath key result identifier.
GET
workpath_list_users
List Workpath users visible to the API client.

/users

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalThe Workpath page number to request. Workpath returns the first page when omitt…
GET
workpath_get_user
Get one Workpath user by their unique identifier.

/users/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe unique Workpath user identifier.
GET
workpath_list_teams
List Workpath teams visible to the API client.

/teams

1 parameter
ParamTypeRequiredDescription
pageintegeroptionalThe Workpath page number to request. Workpath returns the first page when omitt…
GET
workpath_get_team
Get one Workpath team by its unique identifier.

/teams/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe unique Workpath team identifier.