Frequently Asked Questions

How can I receive help with the API?

Please contact [email protected] or ask a question in our discussion section.

How mature is the API? Is it production ready?

Fieldwire API is the core of the Fieldwire platform. The API powers our highly rated web and mobile apps. The API is very mature and 100% production ready. In addition, many of Fieldwire's largest customers utilize the API to perform a variety of actions including: data import and export, archiving, analytics, and automation.

Does the API include all functionality?

Yes, the API supports and allows any action that can be done through our apps.

How often is the API updated?

Fieldwire continuously releases updates to the API but all updates are designed to be backwards compatible with all existing clients integrating with the API. API calls can be pinned to a particular version as explained here

Are there planned maintenance or downtime periods?

Fieldwire releases with a zero downtime deployment strategy.

Does the API support OpenAPI?

Yes. These docs are built using out OpenAPI V3 spec published here:

How does paging work? How do I request subsequent pages of data past the first page?

See guide here.

What are the rate limits around the API?

Each API token has a limit of 10 API calls per second.

Applications that hit the rate limits will receive a 429 error until it is acceptable to make requests again.

Applications can utilize the following headers to handle this situation:

X-RateLimit-LimitIndicates that the limit was hit
X-RateLimit-ResetIndicates the UTC time when the limit is reset

What are the storage and upload limits?

Sheet Upload1 GB
Attachment50 MB

Generally, there is no limit on storage for uploads. Usage is monitored and abuse will result in revocation of API access.

How do I get task categories from the API?

This is a small discrepancy between the Fieldwire UI and the API. What appears as "categories" in the UI, is called "teams" in the API. The payload for the /tasks endpoint will return a team_id. In order to get the name-id maaping you'll need to use the /teams endpoint