Summary
misc
time
Url:
https://api.producteev.com/time.format
Description:
get server time
Return:
RFC 2822 formatted date
back to top
users
users/view
Url:
https://api.producteev.com/users/view.format
Description:
get a user
Return:
array information about the user
Parameters:
- integer id_colleague: (optional) an user can only see information about another user who is on the same dashboard
back to top
users/set_default_dashboard
Url:
https://api.producteev.com/users/set_default_dashboard.format
Description:
set default dashboard
Return:
array information about the user
Parameters:
- integer id_dashboard
back to top
users/colleagues
Url:
https://api.producteev.com/users/colleagues.format
Description:
get information about users that are sharing a workspace with current user
Return:
array: list of user::view
back to top
users/signup
Url:
https://api.producteev.com/users/signup.format
Description:
signup an new user
Return:
users/view
Parameters:
- string email
- string firstname
- string lastname
- string password
- string timezone (see http://code.google.com/p/producteev-api/wiki/TimezonesList for the list of timezones)
back to top
users/attach_facebook_id
Url:
https://api.producteev.com/users/attach_facebook_id.format
Description:
Connect facebook profile with the current user (so he can use Facebook Connect to login into Producteev)
Return:
array: user/view
Parameters:
- string fb_uid (if fb_uid is not specified this method disconnect every facebook profile connected with the user)
back to top
users/detach_facebook_id
Url:
https://api.producteev.com/users/detach_facebook_id.format
Description:
Disconnect facebook profile(s)
Return:
array: user/view
Parameters:
- string fb_uid (if fb_uid is not specified this method disconnect every facebook profile connected with the user)
back to top
users/login
Url:
https://api.producteev.com/users/login.format
Description:
sign in an user using producteev credentials
Return:
on success : string token+email, on fail : HTTP error 401
Parameters:
- integer email
- integer password
back to top
users/fblogin
Url:
https://api.producteev.com/users/fblogin.format
Description:
sign in an user using facebook
Return:
on success : string token+email, on fail : HTTP error 401
Parameters:
- long fb_uid
- string fb_access_token (Facebook oAuth access token)
back to top
users/set_sort_by
Url:
https://api.producteev.com/users/set_sort_by.format
Description:
set sort order
Return:
array: users/view
Parameters:
- integer sort ( by deadline = 1, by manager = 2, by labels = 3, by time_lastchange = 4, by workspace = 5, by priority = 6, by title = 7, by time_created = 8)
back to top
users/set_timezone
Url:
https://api.producteev.com/users/set_timezone.format
Description:
set the timezone for current user
Return:
array: users/view
Parameters:
- string timezone (see http://code.google.com/p/producteev-api/wiki/TimezonesList for the list of timezones)
back to top
users/set_avatar
Url:
https://api.producteev.com/users/set_avatar.format
Description:
update user avatar
Return:
users/view
Parameters:
- picture
back to top
users/forgot_password
Url:
https://api.producteev.com/users/forgot_password.format
Description:
Send an email to the user for reseting his password
Return:
BOOL result on success 1, on fail 0
back to top
dashboards
dashboards/create
Url:
https://api.producteev.com/dashboards/create.format
Description:
create a dasbhoard
Return:
array: list of dashboards/view
Parameters:
- string title: title of the dashboard
back to top
dashboards/view
Url:
https://api.producteev.com/dashboards/view.format
Description:
get a dashboard
Return:
array: information about the dashboard
Parameters:
- integer id_dashboard
- integer show_guest (optional) if not null, the function only returns non-guest users. If set to 1, guest users will be returned
back to top
dashboards/show_list
Url:
https://api.producteev.com/dashboards/show_list.format
Description:
get every dashboard
Return:
array: list of dashboards/view
Parameters:
- string since: (optional) if not null, the function only returns dashboards modified, modified, created or deleted since this date
- integer page: (optional) limits the results at 100 workspaces returned (starts at 1))
- integer show_guest (optional) if not null, the function only returns non-guest users. If set to 1, guest users will be returned
back to top
dashboards/access
Url:
https://api.producteev.com/dashboards/access.format
Description:
return the list of users who can access a specific dashboard
Return:
array: list of dashboards/view
Parameters:
- integer id_dashboard
- integer show_guest (optional) if not null, the function only returns non-guest users. If set to 1, guest users will be returned
back to top
dashboards/leave
Url:
https://api.producteev.com/dashboards/leave.format
Description:
leave a dashboard
Return:
array: (Array("stats" => Array("result" => "TRUE|FALSE"))
Parameters:
- integer id_dashboard
- integer id_user: (optional) id of user who will leave the dashboard. (only work if you are the dashboard admin)
- integer id_user_delegate: (optional) if current user is admin of the dashboard, he has to designate a new admin
back to top
dashboards/set_title
Url:
https://api.producteev.com/dashboards/set_title.format
Description:
change title of a dashboard
Return:
array: dashboards/view
Parameters:
- integer id_dashboard
- string title
back to top
dashboards/set_smart_labels
Url:
https://api.producteev.com/dashboards/set_smart_labels.format
Description:
set value of label_manager_auto
Return:
array: dashboards/view
Parameters:
- integer id_dashboard
- integer on (1 => ACTIVATED, 0 => DEACTIVATED, (ie: manuel order))
back to top
dashboards/delete
Url:
https://api.producteev.com/dashboards/delete.format
Description:
delete a dashboard
Return:
array: (Array("stats" => Array("result" => "TRUE|FALSE"))
Parameters:
- integer id_dashboard
back to top
dashboards/tasks
Url:
https://api.producteev.com/dashboards/tasks.format
Description:
get every tasks of a dashboard
Return:
array: list of tasks::view
Parameters:
- integer id_dashboard
- string since: (optional) if not null, the function only returns tasks modified, created or deleted since this date
- integer page: (optional) limits the results at 100 tasks returned (starts at 1))
back to top
dashboards/confirm
Url:
https://api.producteev.com/dashboards/confirm.format
Description:
confirm invitation for a dashboard
Return:
array: dashboards/view
Parameters:
- integer id_dashboard
back to top
dashboards/refuse
Url:
https://api.producteev.com/dashboards/refuse.format
Description:
refuse invitation for a dashboard
Return:
array: (Array("stats" => Array("result" => "TRUE|FALSE"))
Parameters:
- integer id_dashboard
- integer id_user (optional): current logged user has to be admin of the workspace to be able to refuse an invitaiton for another user
back to top
dashboards/invite_user_by_id
Url:
https://api.producteev.com/dashboards/invite_user_by_id.format
Description:
invite an user to a dashboard
Return:
array dashboards/view
Parameters:
- integer id_dashboard
- integer id_user_to: id of the user to invite
- string message: (optional) personal message sent in the invitation
back to top
dashboards/invite_user_by_email
Url:
https://api.producteev.com/dashboards/invite_user_by_email.format
Description:
invite an user to a dashboard using his/her email
Return:
array dashboards/view
Parameters:
- integer id_dashboard
- string email
- string message: (optional) personal message sent in the invitation
back to top
dashboards/need_upgrade_list
Url:
https://api.producteev.com/dashboards/need_upgrade_list.format
Description:
get every dashboard that needs to be upgraded
Return:
array: list of dashboards/view
back to top
dashboards/needs_upgrade
Url:
https://api.producteev.com/dashboards/needs_upgrade.format
Description:
get upgrade info for a specific dasbhoard
Return:
TRUE if dashboard id_dashboard needs to be upgraded, FALSE otherwise
Parameters:
- integer id_dashboard
back to top
dashboards/reorder
Url:
https://api.producteev.com/dashboards/reorder.format
Description:
reorder dashboard position
Return:
array: list of dashboards/view
Parameters:
- array dashboards - array that contains id_dashboard ordered according new position
back to top
tasks
tasks/create
Url:
https://api.producteev.com/tasks/create.format
Description:
create a task
Return:
array tasks/view
Parameters:
- string title
- integer id_responsible (optional)
- integer id_dashboard (optional);
- string deadline (optional)
- integer all_day (optional), 1: all day task (time specified in deadline will be ignored), 0: deadline with time
- integer reminder (optional) 0 = "None", 1 = "5 minutes before", 2 = "15 minutes before", 3 = "30 minutes before", 4 = "1 hour before", 5 = "2 hours before", 6 = "1 day before", 7 = "2 days before", 8 = "on date of event"
- integer status (optional) 1 = UNDONE, 2 = DONE
- integer star (optional) (0 to 5 stars)
- string repeating_interval (possible values: "day(s), weekday(s), week(s), month(s), year(s)") note: repeating is set only if a correct deadline has been specified
- integer repeating_value (optional) (default = 1) every X repeating_interval
- mixed id_label: can be an array of integer or just an integer
back to top
tasks/view
Url:
https://api.producteev.com/tasks/view.format
Description:
get a task
Return:
array : information about the task
Parameters:
- integer id_task
- string since: (optional) if not null, the function only returns notes modified, created or deleted since this date
back to top
tasks/show_list
Url:
https://api.producteev.com/tasks/show_list.format
Description:
return tasks (return 100 results maximum, specifying a page number allows to get more results)
Return:
array: list of tasks/view ordered by time_lastchange
Parameters:
- string id_dashboard: (optional) if null return every task for current user, otherwise return only tasks for this dashboard
- string since: (optional) if not null, the function only returns tasks modified, created or deleted since this date
- integer page: (optional) limits the results at 100 tasks returned (starts at 1))
back to top
tasks/my_tasks
Url:
https://api.producteev.com/tasks/my_tasks.format
Description:
get uncompleted tasks related to an user (either creator, assigner or responsible or posted a note on this task)
Return:
array: list of tasks/view
Parameters:
- string id_dashboard: (optional) if null return tasks for every user
- string since: (optional) if not null, the function only returns tasks modified, created or deleted since this date
- integer page: only 100 tasks are returned (starts at 1) if not specified, page = 1
back to top
tasks/archived
Url:
https://api.producteev.com/tasks/archived.format
Description:
get completed tasks related to an user
Return:
array: list of tasks/view
Parameters:
- string id_dashboard: (optional) if null return tasks for every user's workspace
- string since: (optional) if not null, the function only returns tasks modified, created or deleted since this date
- integer page: only 100 tasks are returned (starts at 1) if not specified, page = 1
back to top
tasks/my_team_tasks
Url:
https://api.producteev.com/tasks/my_team_tasks.format
Description:
get every task not related to an user (neither creator, responsible or assigner)
Return:
array: list of tasks/view
Parameters:
- string id_dashboard: (optional) if null return tasks for every user's workspace
- string since: (optional) if not null, the function only returns tasks modified, created or deleted since this date
- integer page: only 100 tasks are returned (starts at 1) if not specified, page = 1
back to top
tasks/set_title
Url:
https://api.producteev.com/tasks/set_title.format
Description:
change title of a task
Return:
array: tasks/view
Parameters:
- integer id_task
- string title
back to top
tasks/set_status
Url:
https://api.producteev.com/tasks/set_status.format
Description:
set status of a task
Return:
array: tasks/view
Parameters:
- integer id_task
- integer status (1 = UNDONE, 2 = DONE)
back to top
tasks/set_star
Url:
https://api.producteev.com/tasks/set_star.format
Description:
set star status of a task
Return:
array: tasks/view
Parameters:
- integer id_task
- integer star (0 to 5 stars)
back to top
tasks/set_responsible
Url:
https://api.producteev.com/tasks/set_responsible.format
Description:
change responsible of a task
Return:
array tasks/view
Parameters:
- integer id_task
- integer id_responsible
back to top
tasks/unset_responsible
Url:
https://api.producteev.com/tasks/unset_responsible.format
Description:
void the responsible of a task
Return:
array tasks/view
Parameters:
- integer id_task
back to top
tasks/set_deadline
Url:
https://api.producteev.com/tasks/set_deadline.format
Description:
set a deadline
Return:
array: tasks/view
Parameters:
- integer id_task
- string deadline
- integer all_day (optional), 1: all day task (time specified in deadline will be ignored), 0: deadline with time
back to top
tasks/unset_deadline
Url:
https://api.producteev.com/tasks/unset_deadline.format
Description:
unset a deadline
Return:
array: tasks/view
Parameters:
- integer id_task
back to top
tasks/set_reminder
Url:
https://api.producteev.com/tasks/set_reminder.format
Description:
set a reminder
Return:
array: tasks/view
Parameters:
- integer id_task
- integer reminder (0 = "None", 1 = "5 minutes before", 2 = "15 minutes before", 3 = "30 minutes before", 4 = "1 hour before", 5 = "2 hours before", 6 = "1 day before", 7 = "2 days before", 8 = "on date of event")
back to top
tasks/set_repeating
Url:
https://api.producteev.com/tasks/set_repeating.format
Description:
Set a repeating task
Return:
array tasks/view
Parameters:
- integer id_task
- string repeating_interval, allowed intervals are: "day(s), weekday(s), week(s), month(s) and year(s)"
- integer repeating_value (optional, default = 1) every X interval
back to top
tasks/unset_repeating
Url:
https://api.producteev.com/tasks/unset_repeating.format
Description:
Unset a repeating task
Return:
array tasks/view
Parameters:
- integer id_task
back to top
tasks/delete
Url:
https://api.producteev.com/tasks/delete.format
Description:
delete a task
Return:
array with the result = (Array("stats" => Array("result" => "TRUE|FALSE"))
Parameters:
- integer id_task
back to top
dashboards/access
Url:
https://api.producteev.com/dashboards/access.format
Description:
get list of users that can access a task
Return:
array: list of users/view
Parameters:
- integer id_task
back to top
tasks/labels
Url:
https://api.producteev.com/tasks/labels.format
Description:
get labels assigned to a task
Return:
array: list of labels/view
Parameters:
- integer id_task
back to top
tasks/change_labels
Url:
https://api.producteev.com/tasks/change_labels.format
Description:
attach label(s) to a task (previously attached labels will be removed.)
Return:
array: tasks/view
Parameters:
- integer id_task
- mixed id_label: can be an array of integer or just an integer. If null or not specified, remove every label on the task
back to top
DEPRECATED tasks/set_label
Url:
https://api.producteev.com/DEPRECATED tasks/set_label.format
Description:
attack label(s) to a task
Return:
array: tasks/view
Parameters:
- integer id_task
- mixed id_label: can be an array of integer or just an integer
back to top
DEPRECATED tasks/unset_label
Url:
https://api.producteev.com/DEPRECATED tasks/unset_label.format
Description:
detach a label
Return:
array: tasks/view
Parameters:
- integer id_task
- integer id_label
back to top
tasks/set_workspace
Url:
https://api.producteev.com/tasks/set_workspace.format
Description:
set a workspace
Return:
array tasks/view
Parameters:
- integer id_task
- integer id_dashboard
back to top
tasks/note_view
Url:
https://api.producteev.com/tasks/note_view.format
Description:
get a note
Return:
array: information about the task
Parameters:
- integer id_note
- array note information about the note (don't use this parameters
back to top
tasks/notes_get
Url:
https://api.producteev.com/tasks/notes_get.format
Description:
get every note of a task
Return:
array list of tasks/note_view
Parameters:
- integer id_task
- string since: (optional) if not null, the function only returns notes modified, created or deleted since this date
back to top
tasks/note_create
Url:
https://api.producteev.com/tasks/note_create.format
Description:
create a note attached to a task
Return:
array tasks::note_view
Parameters:
- string message
- integer id_task
- file
back to top
tasks/note_delete
Url:
https://api.producteev.com/tasks/note_delete.format
Description:
delete a note
Return:
array: (Array("stats" => Array("result" => "TRUE|FALSE"))
Parameters:
- integer id_note
back to top
tasks/activity_view
Url:
https://api.producteev.com/tasks/activity_view.format
Description:
get task_activity
Return:
array: information about the task_activity
Parameters:
- integer id_activity
back to top
tasks/activities_get
Url:
https://api.producteev.com/tasks/activities_get.format
Description:
get task_activities for a given task
Return:
array: list of tasks/activity_view
Parameters:
- integer id_task
- integer page: (optional) limits the results at 100 activities returned (starts at 1))
back to top
tasks/subtasks
Url:
https://api.producteev.com/tasks/subtasks.format
Description:
return subtasks attached to a given task
Return:
array subtasks/view
Parameters:
- integer id_task
back to top
labels
labels/view
Url:
https://api.producteev.com/labels/view.format
Description:
get a label
Return:
array: information about the label
Parameters:
- integer id_label
back to top
labels/show_list
Url:
https://api.producteev.com/labels/show_list.format
Description:
get every label for a given dashboard (return all labels if id_dashboard is not specified)
Return:
list of labels/view
Parameters:
- integer id_dashboard (optional)
- string since: (optional) if not null, the function only returns labels modified, created or deleted since this date
- integer page: (optional) limits the results at 100 labels returned (starts at 1))
back to top
labels/create
Url:
https://api.producteev.com/labels/create.format
Description:
create a label
Return:
array: labels/view
Parameters:
- integer id_dashboard
- string title
back to top
labels/delete
Url:
https://api.producteev.com/labels/delete.format
Description:
delete a label (only the creator of the label can do it)
Return:
array with the result = (Array("stats" => Array("result" => "TRUE|FALSE"))
Parameters:
- integer id_label
back to top
labels/tasks
Url:
https://api.producteev.com/labels/tasks.format
Description:
get every task for a given label
Return:
array: list of tasks::view
Parameters:
- integer id_label
- integer page: (optional) limits the results at 100 tasks returned (starts at 1))
back to top
($pagelabels/set_title
Url:
https://api.producteev.com/($pagelabels/set_title.format
Description:
1);change the title of the label
Return:
array: labels/view
Parameters:
- integer id_label
- string title
back to top
activities
activities/show_activities
Url:
https://api.producteev.com/activities/show_activities.format
Description:
get activities. Don't return activities older than 1 month
Return:
array: list of activities/view
Parameters:
- integer id_dashboard: (optional) if not null, this function only returns notifications for this specific dashboard
- integer last_id: (optional) this function returns only activities later than this id
- integer page: (optional) limits the results at 100 activities returned (starts at 1))
back to top
activities/show_notifications
Url:
https://api.producteev.com/activities/show_notifications.format
Description:
get every notifications (notifications are activities that current user is concerned about). Don't return notifications older than 1 month
Return:
array: list of activities/view
Parameters:
- integer id_dashboard: (optional) if not null, this function only returns notifications for this specific dashboard
- integer last_id: (optional) if not null, this function returns only notifications later than this id
- integer page: (optional) limits the results at 100 activities returned (starts at 1))
back to top
activities/notifications_set_read
Url:
https://api.producteev.com/activities/notifications_set_read.format
Description:
set notifications status as read
Return:
array:list of activities/view
Parameters:
- integer id_dashboard
- integer last_id: every notification anterior to this id will be set as read
back to top
activities/set_read
Url:
https://api.producteev.com/activities/set_read.format
Description:
set activities status as read
Return:
array:list of activities/view
Parameters:
- mixed id_activity: can be an array of integer or just an integer.
back to top
subtasks
subtasks/view
Url:
https://api.producteev.com/subtasks/view.format
Description:
get a subtask
Return:
array: information about the subtask
Parameters:
- integer id_subtask
back to top
subtasks/create
Url:
https://api.producteev.com/subtasks/create.format
Description:
create a subtask
Return:
subtasks/view
Parameters:
- id_task
- title
back to top
subtasks/delete
Url:
https://api.producteev.com/subtasks/delete.format
Description:
delete a subtask
Return:
array with the result = (Array("stats" => Array("result" => "TRUE|FALSE"))
Parameters:
- integer id_subtask
back to top
subtasks/set_position
Url:
https://api.producteev.com/subtasks/set_position.format
Description:
set position for a specific subtask
Return:
array subtasks/view
Parameters:
- integer id_subtask
back to top
subtasks/set_title
Url:
https://api.producteev.com/subtasks/set_title.format
Description:
set title for a given subtask
Return:
array subtasks/view
Parameters:
- integer id_subtask
- string title
back to top