Overview
Fieldwire provides an Open RESTful API (application program interface) to customers on an Enterprise-level contract, or who have added API access to their Pro/Business/Business Plus plan in conjunction with our sales team. (See our pricing page for more details).
Please request a demo if you're interested in learning more about how you can use our API and/or upgrading your account to access it!
Table of Contents
API Access: Determine Your Next Step
Your next steps depend on whether your account already has API access enabled.
- IF your account already has API access enabled THEN you can generate an API token by following the steps in the “How to generate API keys” section below AND no additional purchase or sales contact is required
- IF your account does NOT have API access enabled THEN you will need to work with our Sales team to upgrade your account or add API access to your current plan AND you will NOT be able to generate API tokens until API access has been enabled
API functionality
Our API allows you to do anything that you can do in the Fieldwire user interface (and more), but with coding! Some popular ways our customers use the API are to bulk import existing project data from other systems to Fieldwire when migrating to our platform, synchronize data between other software platforms and Fieldwire, automatically copy Fieldwire plans and documents to their own servers, and analyze large amounts of data across multiple projects.
Developer Access and API Keys
Account Owners and Managers can request Developer access, generate API tokens, see if API access is enabled or disabled, and view our API Documentation under the 'API Settings' section of the 'Account' tab on your Fieldwire account home page.
How to activate developer access (Requires API access)
IMPORTANT: You must already have API access enabled on your account before requesting developer access. If you do not yet have API access, please see the “API Access: Determine Your Next Step” section above.
1. Talk to our Accounts Team to acquire an API demo and purchase a custom Premium Fieldwire subscription with API access.
2. Navigate to the Home page on Fieldwire web, click to view your 'Account' tab, and scroll down to the 'API Settings' section at the very bottom.
3. Click the link to 'Request API developer access':
3. A popup to email support@fieldwire.com will appear. Please include the context for your request and be sure to click the blue 'Send' button:
4. Our team will reply to confirm that we've activated your account's API access.
How to generate API keys
IMPORTANT:
- You can only generate API keys if BOTH of the following are true:
- API access is enabled on your account
- Developer access has already been activated
IF you do not see the “Manage tokens” option in your API Settings THEN you may still need to request developer access or confirm that API access is enabled.
1. Follow the instructions above to obtain developer access.
2. When you navigate to the API Settings section at the bottom of the Account tab of your Fieldwire home page, the link for "Request API developer access" will be gone. (If it's not, you still need to follow the instructions above to request access). If you're seeing a link to "Manage tokens" in its place, then you're good to go. Click that link to proceed:
3. Click "New Token" to generate an API key for your account.
Note: Up to 10 API keys can be generated per Fieldwire account. Please ensure that they are stored safely and only shared with authorized individuals.
4. Give your API key a unique name, then click "Create".
5. The following popup will now reveal a unique API token. Be sure to keep this token stored in a secure place, as you will not be able to access it again once you close the popup.
If you accidentally close the popup, you can revoke the token and generate a new one.
Note: Revoking will deactivate the old token, so any instances where it has been used should be updated with the new token.
If you have any issues with API tokens after following these instructions, please email support@fieldwire.com.
Summary of Requirements
To generate an API token, ALL of the following must be true:
- Your account includes API access (Enterprise or added via Sales)
- Developer access has been requested and approved
- You can see the “Manage tokens” option in API Settings
IF any of these are missing THEN you will not be able to generate an API token.
API Developer Page
- Once you have access to our API, please refer to our API Developers doc for guidance.
- To see recent changes in the API structure, please view our changelog
- Similarly, you can subscribe to the RSS feed changelog
- Sign up for API Changelog email notifications, if you so desire
Note: Custom Task Status API calls aren't visible on our API Developers doc yet. Please make sure to follow this guide for CTS API calls.