Skip to main content

A wrapper for the Fieldaware API

Project description

A python wrapper for the FieldAware API.

requires a FIELDAWARE_TOKEN environment variable


Fawrapper is currently supported on python 3.6

pip install git+


Assuming you already have at token provided by Fieldaware, you can create an intance of the FieldawareAPIClient like so:

from fawrapper import FieldawareAPIClient

# If you have set the environment variable ``FIELDAWARE_TOKEN``
api = FieldawareAPIClient()

# Or you can include the token
api = FieldawareAPIClient(api_key="your_token")

With the api instance you can interact with Fieldaware:

# List all users
users_list = api.users.list()
for user in users_list:
  print('First Name: ', user.first_name, 'UUID: ', user.uuid)

# List all jobs
jobs_list =
for job in jobs_list:
  print('Job Number: ',, 'UUID: ', job.uuid)

# Get a user with uuid
user = api.users.get('user_uuid')

# Get a job with uuid
job ='job_uuid')

# With the Job and a User instance, you can update the api by setting the
# attribute to the user
job.job_lead = user




If you find an API method that is not supported yet, feel free to create a Github issue.

You are more than welcome to submit a pull request for bug fixes or additional features.

Thank you!


MIT License

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

fawrapper-0.1.0a6.tar.gz (12.7 kB view hashes)

Uploaded source

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