Skip to main content

A Python client library for

Project description


A Workstreams Python Client Library

For an overview of the Workstream API, click here.


  • Python >= 3.6
  • Requests >= 2.19.0

Getting started

pip install workstreams

workstreams is very simple to use -- take a look at the below example:

from workstreams import WorkstreamsClient

workstreams = WorkstreamsClient('your token')

workstreams.tasks.create(team_id='T3T7BFHGV', channel_id='C3T7D66J1', ws_user_id='U3T716H3N', data={
    'title': 'test task',
    'labels': [
    'dueDate': '2018-03-07T11:46:17Z',
    'assignee': 'U3T716H3N'

Tasks Resource

Note: ws_user_id must always be provided for app tokens.

Available methods:

  • create(team_id, channel_id, data, ws_user_id=None) - Creates a task
  • update(task_id, data, ws_user_id=None) - Updates a task
  • fetch(task_id, ws_user_id=None) - Fetch a single task
  • fetch_user_tasks(team_id, user_id, ws_user_id=None) - Fetch tasks for a single user
  • fetch_tasks_for_users(team_id, user_ids, ws_user_id=None) - Fetch tasks for multiple users
    • Example: fetch_tasks_for_users(team_id='T3T7BFHGV', user_ids=['U123456', 'U123457', 'U123458'], ws_user_id=None)
  • fetch_tasks_for_channels(team_id, channel_ids) - Fetch all tasks for multiple channels
    • Example: fetch_tasks_for_channels(team_id='T3T7BFHGV', channel_ids=['C3T7D66J1', 'C3T7D66J2'], ws_user_id=None)
  • fetch_changed_tasks_for_channels(team_id, channel_ids, timestamp, ws_user_id=None) - Fetch all tasks for multiple channels which changed since given timestamp
  • fetch_archived_tasks_for_channels(team_id, channel_ids, ws_user_id=None) - Fetch all archived tasks for multiple channels
  • archive_tasks(task_ids, ws_user_id=None) - Archive multiple tasks
  • restore_tasks(task_ids, ws_user_id=None) - Restore multiple tasks



Bug Reports


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for workstreams, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size workstreams-1.0.4-py3-none-any.whl (9.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size workstreams-1.0.4.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page