tasks.team.getList

Apps » Teamwork API »

Returns the list of all colleagues of the current user who have access to Teamwork.

Parameters

  • format GET Optional

    Sets response format. Available options: json (default), xml.

Return value

Array with the following keys:

  • data array User list. Each list item is an array with the following keys:
  • data[]['contact'] array User data array with the following keys:
  • data[]['contact']['id'] int User ID.
  • data[]['contact']['name'] string User name.
  • data[]['contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • data[]['contact_info'] array User’s contact data array with the following keys:
  • data[]['contact_info']['name'] string Full name.
  • data[]['contact_info']['title'] string Title.
  • data[]['contact_info']['firstname'] string First name.
  • data[]['contact_info']['middlename'] string Middle name.
  • data[]['contact_info']['lastname'] string Last name.
  • data[]['contact_info']['about'] string Description.
  • data[]['contact_info']['jobtitle'] string Job title.
  • data[]['contact_info']['gender'] string|null Gender: 'm' (male), 'f' (female).
  • data[]['contact_info']['address'] array The list of postal addresses. Each list item is an array with the following keys:
  • data[]['contact_info']['address'][]['value'] string Full address as a string.
  • data[]['contact_info']['address'][]['ext'] string Address type: shipping or payment.
  • data[]['contact_info']['birthday'] date|null Birth date.
  • data[]['contact_info']['email'] array The list of email addresses. Each list item is an array with the following keys:
  • data[]['contact_info']['email'][]['value'] string Email address.
  • data[]['contact_info']['email'][]['ext'] string Email address type: work, personal, ... (custom label for the “other” type).
  • data[]['contact_info']['im'] array The list of online messenger identifiers. Each list item is an array with the following keys:
  • data[]['contact_info']['im'][]['value'] string Identifier.
  • data[]['contact_info']['im'][]['ext'] string Identifier type: work, personal, ... (custom label for the “other” type).
  • data[]['contact_info']['large_photo_url'] string Image URL.
  • data[]['contact_info']['locale'] string Language locale.
  • data[]['contact_info']['socialnetwork'] array The list of social media identifiers. Each list item is an array with the following keys:
  • data[]['contact_info']['im'][]['value'] string Identifier.
  • data[]['contact_info']['im'][]['ext'] string Identifier type: work, personal, ... (custom label for the “other” type).
  • data[]['contact_info']['timezone'] string Time zone name.
  • data[]['contact_info']['url'] array The list of website addresses. Each list item is an array with the following keys:
  • data[]['contact_info']['url'][]['data'] string Website address.
  • data[]['contact_info']['url'][]['ext'] string Address type: work, personal, ... (custom label for the “other” type).
  • data[]['counts'] array Counters of tasks, assigned to the user, as an array with the following keys:
  • data[]['counts']['active'] int Number of active tasks.
  • data[]['counts']['active_priority'] int Number of active tasks with a high priority.
  • data[]['counts']['closed'] int Number of closed tasks.
  • data[]['counts']['total'] int Total number of tasks.
  • data[]['groups'] array<string> The list of groups in which the user is included. Array keys are group IDs, values are group names.
  • data[]['last_log'] array Information about the latest action, executed by the user, as an array with the following keys:
  • data[]['last_log']['action'] string Action performed an a task.
  • data[]['last_log']['after_status_id'] int ID of the status in which the task had been before the action was executed.
  • data[]['last_log']['assigned_contact'] array Information about the user, to which the task was assigned, with the following keys:
  • data[]['last_log']['assigned_contact']['id'] int User ID.
  • data[]['last_log']['assigned_contact']['name'] string User name.
  • data[]['last_log']['assigned_contact']['is_me'] bool Flag denoting whether the action was executed by the current user.
  • data[]['last_log']['assigned_contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • data[]['last_log']['assignment_changed'] bool Flag denoting whether the task was assigned to another user when the action was executed.
  • data[]['last_log']['attachments'] array The list of files during the action execution. Each array item is an array with the following keys:
  • data[]['last_log']['attachments'][]['id'] int File ID.
  • data[]['last_log']['attachments'][]['code'] string Random file code.
  • data[]['last_log']['attachments'][]['contact'] array The properties of the user, who executed the action, as an array with the following keys:
  • data[]['last_log']['attachments'][]['contact']['id'] int User ID.
  • data[]['last_log']['attachments'][]['contact']['is_me'] bool Flag denoting whether the action was executed by the current user.
  • data[]['last_log']['attachments'][]['contact']['name'] string User name.
  • data[]['last_log']['attachments'][]['contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • data[]['last_log']['attachments'][]['create_datetime'] string Date and time of the action execution in the ISO 8601 format.
  • data[]['last_log']['attachments'][]['download_url'] string File URL.
  • data[]['last_log']['attachments'][]['ext'] string File name extension.
  • data[]['last_log']['attachments'][]['is_image'] bool Flag denoting whether the file contains an image.
  • data[]['last_log']['attachments'][]['log_id'] int ID of the entry about the added comment in the user actions log.
  • data[]['last_log']['attachments'][]['name'] string File name.
  • data[]['last_log']['attachments'][]['preview_url'] string URL of the file’s preview image.
  • data[]['last_log']['attachments'][]['size'] int File size in bytes.
  • data[]['last_log']['before_status_id'] int ID of the status in which the task had been before the action execution.
  • data[]['last_log']['contact'] array The properties of the user, who executed the action, with the following keys:
  • data[]['last_log']['contact']['id'] int User ID.
  • data[]['last_log']['contact']['name'] string User name.
  • data[]['last_log']['contact']['photo_url'] string URL of a 96x96 pixels large user image.
  • data[]['last_log']['create_datetime'] string Date and time of the action execution in the ISO 8601 format.
  • data[]['last_log']['project_id'] int ID of the project to which the task belongs.
  • data[]['last_log']['status_changed'] bool Flag denoting whether the task status was changed during the action execution.
  • data[]['last_log']['task_id'] int Task ID.
  • data[]['last_log']['task_name'] string Task name.
  • data[]['last_log']['task_number'] string Task’s number within its project.
  • data[]['last_log']['text'] string Text entered by a user during the action execution.
  • data[]['last_log']['text_stripped'] string Entered text without HTML tags, truncated to maximum 256 characters.
  • data[]['sort'] int Sort value.
  • data[]['status'] array|null Information about the current user status, set in their calendar, as an array with the following keys:
  • data[]['status']['name'] string Status description.
  • data[]['status']['font_color'] string HTML color value of the status label text.
  • data[]['status']['bg_color'] string HTML color value of the status label background.

Example

https://demo1.webasyst.com/api.php/tasks.team.getList?