Skip to main content

A wrapper for the API at

Project description

Float API

A Python wrapper of the project management service at

There is an example of how to use the wrapper here:

The API is documented here:

To install with pip: pip install float-api

Example of use

To use the API, you must pass the FLOAT_ACCESS_TOKEN to the FloatAPI object when instantiating it. You must also supply a string of your own choice to use as User-Agent as well as an email address where you can be contacted. Read the documentation here.

# Import the API
from float_api import FloatAPI

# Instantiate API object
api = FloatAPI(FLOAT_ACCESS_TOKEN, 'My user agent', '')

# Get a list of all people
p = api.get_all_people()


These are the calls implemented in this wrapper. If the input to a function is DATA, it means a list of relevant arguments. See the Float documentation for details. get_all_* calls returns lists, delete_* returns True or False. Other calls return dictionaries. On error, the wrapper will return empty lists, False and empty dictionaries respectively.


  • get_all_clients()
  • create_client(data)
  • get_client(client_id)
  • update_client(data)
  • delete_client(client_id)


  • get_all_people()
  • get_people_reports(start_date, end_date, [people_id])
  • create_person(data)
  • get_person(people_id)
  • update_person(data)
  • delete_person(people_id)


  • get_all_projects()
  • get_project_reports(start_date, end_date, [project_id])
  • create_project(data)
  • get_project(project_id)
  • update_project(data)
  • delete_project(project_id)


  • get_all_tasks([start_date],[end_date])
  • create_task(data)
  • get_task(task_id)
  • update_task(data)
  • delete_task(task_id)

Time off types

  • get_all_timeoff_types()
  • create_timeoff_type(data)
  • get_timeoff_type(timeoff_type_id)
  • update_timeoff_type(data)
  • delete_timeoff_type(timeoff_type_id)


Test the wrapper by running pytest in the repository's root directory.

Project details

Download files

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

Source Distribution

float_api-0.0.13.tar.gz (5.1 kB view hashes)

Uploaded source

Built Distribution

float_api-0.0.13-py3-none-any.whl (6.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page