← Tools Reference

Worksnaps

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

API key10 toolshttps://api.worksnaps.com/api
GET
worksnaps_get_current_user
Read the current Worksnaps user profile for the connected API token.

/me.xml

GET
worksnaps_list_projects
List Worksnaps projects that the current user is involved in.

/projects.xml

1 parameter
ParamTypeRequiredDescription
includeUserAssignmentbooleanoptionalWhether Worksnaps should include project member assignments in each project rec…
GET
worksnaps_get_project
Read one Worksnaps project by project ID.

/projects/{projectId}.xml

2 parameters
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID to retrieve.
includeUserAssignmentbooleanoptionalWhether Worksnaps should include project member assignments in the response.
GET
worksnaps_list_project_tasks
List tasks that belong to one Worksnaps project.

/projects/{projectId}/tasks.xml

2 parameters
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID whose tasks should be listed.
includeTaskAssignmentbooleanoptionalWhether Worksnaps should include task assignments in each task record.
GET
worksnaps_get_task
Read one Worksnaps task by project ID and task ID.

/projects/{projectId}/tasks/{taskId}.xml

2 parameters
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID that owns the task.
taskIdintegerrequiredThe Worksnaps task ID to retrieve.
GET
worksnaps_list_project_user_assignments
List user assignments for one Worksnaps project.

/projects/{projectId}/user_assignments.xml

1 parameter
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID whose members should be listed.
GET
worksnaps_list_project_task_assignments
List task assignments for one Worksnaps project.

/projects/{projectId}/task_assignments.xml

1 parameter
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID whose task assignments should be listed.
GET
worksnaps_list_project_time_entries
List Worksnaps time entries in one project for one or more users.

/projects/{projectId}/time_entries.xml

6 parameters
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID whose time entries should be listed.
userIdsarrayrequiredA non-empty list of Worksnaps numeric identifiers.
fromTimestampstringrequiredThe starting Unix timestamp string at a 10-minute boundary.
toTimestampstringrequiredThe ending Unix timestamp string at a 10-minute boundary.
taskIdsarrayoptionalA non-empty list of Worksnaps numeric identifiers.
timeEntryTypestringoptionalThe Worksnaps time entry type filter.
GET
worksnaps_get_project_time_entry
Read one Worksnaps time entry by project ID and time entry ID.

/projects/{projectId}/time_entries/{timeEntryId}.xml

2 parameters
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID that owns the time entry.
timeEntryIdintegerrequiredThe Worksnaps time entry ID to retrieve.
GET
worksnaps_get_project_time_report
Read a Worksnaps project report for a bounded time window and user set.

/projects/{projectId}/reports

7 parameters
ParamTypeRequiredDescription
projectIdintegerrequiredThe Worksnaps project ID whose report should be generated.
reportTypestringrequiredThe Worksnaps report type to request.
fromTimestampstringrequiredThe starting Unix timestamp string at a 10-minute boundary.
toTimestampstringrequiredThe ending Unix timestamp string at a 10-minute boundary.
userIdsarrayrequiredA non-empty list of Worksnaps numeric identifiers.
taskIdsarrayoptionalA non-empty list of Worksnaps numeric identifiers.
timeEntryTypestringoptionalThe Worksnaps time entry type filter.