developers.upwork.comUpwork API Reference

STACKOVERFLOW GETTING STARTED TOS FAQ CHANGELOG ￪ to the top ↵ back to Upwork Introduction Getting Started Preparation Application permissions Authentication Libraries and Tools Architecture style Request structure Cross-domain requests Versioning Response format Response elements Pagination Encoding Rate Limits Error Handling Terminology Authentication OAuth 1.0 Get request token Authorize and get verifier Get access token Required OAuth 1.0 parameters Troubleshooting authentication issues Authentication (Beta) OAuth 2.0 Supported Grants Authorization Request Access Token Request Refresh Access Token Request Troubleshooting issues Users Authenticated User Referenced User User Permissions Public Profiles Search for freelancers Get brief profile summary Get profile details Jobs Search for jobs List jobs Get job by key Post job Update job Cancel job Get job profile Invite to interview Companies and Teams List companies Get company List teams in company List users in company List teams List users in team Get Work Diary Get Work Diary by List of Contracts Get Work Diary by Contract Get Workdays by Company Get Workdays by Contract Contracts and Offers List client offers Get client offer Send client offer List freelancer’s offers Get freelancer’s offer Accept or decline an offer List job applications as client Get job application as client List job applications as freelancer Get job application as freelancer List engagements Get engagement Suspend contract Restart contract End contract Milestones Get active milestone List submissions for a milestone Create a milestone Edit a milestone Activate a milestone Approve a milestone Delete a milestone Submit work to a milestone Approve a milestone submission Reject a milestone submission Payments Make custom payment Messages Retrieve rooms information Get a specific room information Get a specific room by offer ID Get a specific room by application ID Get a specific room by contract ID Create a new room Send a message to a room Update a room settings Archive or rename a room Activities List team activities List activities for specific engagement Get team activity by code Create activity at team level Update activity at team level Assign engagements to the list of activities Assign to specific engagement the list of activities Archive activities Unarchive activities Update bulk of activities Snapshots Get snapshot by Contract Reports Time reports fields Time reports grammar Financial reports fields Financial reports grammar Get time reports for a team (hours only) Get time reports for a team Get companywide time reports Get agency specific time reports Get freelancer specific time reports (hours only) Get freelancer specific time reports Get billing reports for a freelancer Get earning reports for a freelancer Get billing reports for a client’s team Get billing reports for a client’s company Get earning reports for a client’s team Get earning reports for a client’s company Get financial reports for an account Metadata List specialties V2 List categories V2 List skills List skills V2 List geographical regions List tests List reasons python php ruby java node perl GO Introduction Integrate Upwork functionalities to your web-based or mobile apps Upwork Developers Site offers you access to our web services to build your own applications and to integrate our features and workflow to your dashboards, websites and management systems. Please read Terms of use prior to using the Upwork Public API. Featured functionalities • Authenticate and authorize your users with Upwork • Search for freelancers and find jobs • Create job postings • Invite freelancers to an interview • Make job offers • Manage existing contracts • Make custom payments • Close contracts • Manage activities for your team • Manage, send and receive messages • Retrieve time and financial reports for freelancers, teams and companies • Manage work diary snapshots • Retrieve metadata information - available categories, tests, skills, regions, etc. Getting started is easy. Check out our Getting Started section to learn about the core concepts of our API, such as supported authentication methods, languages and formats. This page contains complete API reference documentation about our API technical implementation, just use your browser search or navigation panel on the left. Have a question? Visit us at: Help Center StackOverflow Github Community Forum Don’t forget to visit our Recent changes section to check out the new releases and features. Libraries Here you can find a list of available libraries for several languages . API Entry Point https://www.upwork.com/api For Reports resources: https://www.upwork.com/gds Getting Started Preparation Before you start using Upwork API, you need to register your application and obtain your client credentials (a.k.a consumer key and consumer secret). To register, you just fill in basic information about your application and its intended use. Register a new application Note Every new request for an API Key will be reviewed. For a quick positive decision, you need to comply the following conditions: your Upwork profile must have: a. a valid name in your profile (no fake names, no company names) b. a full valid address (including apartment number) - either in your personal or your company’s profile c. a valid profile portrait provide a clear description on what you are planning using our APIs for (this info is required when you apply for a key). Make sure you add a note stating if you are going to use your application internally or publicly, or for any other purposes. agree to use the Upwork API in a manner that does not exceed a reasonable request volume. Our daily allowed limit is 40K requests. refrain from using the Upwork logo, brand name, brand theme/colors and trademarked content in your application meet the other requirement described on this Support Page Warning Users who try registering a new application/key, but have a profile without a valid ID will be forced to go through the ID verification process. Application Permissions When you register a new application, you are asked to define a list of permissions to access third-party resource data; we call them “Application Permissions”. You can later modify the application permissions you request, but note that doing so makes all previously generated access tokens invalid. You will also have to request authorization from resource owners again. See the list of your registered applications (keys) Authentication To access Upwork API, you need to go through an authentication process. Currently, we support the OAuth 1.0 method. Note You need to authenticate for all requests following the OAuth 1.0, RFC 5849 . The authentication process is simple. See the authentication section for a detailed description. Libraries and Tools A library is a collection of behavior implementations, written in a specific programming language. Libraries help you make system calls without the need to re-write code over and over again. These are the libraries built specifically to support Upwork API: Python PHP Ruby Java (+ Android, Maven, etc.) JavaScript/NodeJS Perl GO On the right-hand side you can see the examples of how to make API calls with the chosen library. Additionally, you can find a list of libraries for the language of your choice to help you with the OAuth mechanism here . To start using most of these libraries, you just need to provide your client credentials and the necessary URLs. Try examples $ mkdir upwork_project $ cd upwork_project $ virtualenv --no-site-packages ve $ git clone https://github.com/upwork/python-upwork.git $ cd python-upwork $ source ../ve/bin/activate Install latest version from master: $ python setup.py install Or you can use pip to install latest stable version from PyPI : $ pip install python_upwork Run the example application: $ cd examples $ python desktop_app.py $ mkdir php_project $ cd php_project $ cat > composer.json ...