Author Mark Percy

Users API Field Squared supports a RESTful API that handles both single object and list operations. Users in Field Squared are written to the API as either a single user or a list of user objects. For most integrations we recommend doing batch updates of users (create, update) as array operations. For additional rules around API data […]

Assets API Field Squared supports a RESTful API that handles both single object and list operations. Assets in Field Squared are written to the API as either a single asset or a list of asset objects. For most integrations we recommend doing batch updates of assets (create, update) as array operations. For additional rules around API data […]

Configuring Field Squared for Pushing Data to a Third Party API The Field Squared API can POST Field Squared objects to a third party API: whenever the object is created, updated or deleted (an "event" based request) on a schedule (example: every day at 2am) on request through an API request […]

Custom Fields in the API Custom fields are used by Field Squared objects to customize the screens inside your app. Custom fields are used to extend Tasks, Assets, Contacts, Users, Teams and Catalogs. You can use custom fields to capture data, or just to display data that's coming from your existing database. […]

Missing, Null and Empty Properties in API calls When calling the Field Squared API to create or update an object, you can construct API calls that omit properties: you create an API call that includes some but not all of the available API properties includes null/empty properties: the properties are […]

Syncing external systems with ExternalID Field Squared can automatically insert or update a record as required whenever the API is called by using a field called External ID that cross references objects in Field Squared with ID's that are in your existing database of API. If you call the Field Squared […]

Tasks API Field Squared supports a RESTful API that handles both single object and list operations. Tasks in Field Squared (also known as Work Orders or Jobs) are written to the API as either a single task or a list of task objects. For most integrations we recommend doing batch updates of […]

API Data Types and Notes The following guide applies to our API at runtime and data exchange. API Success Messages All successful calls to the FS API will return HTTP status code 200 OK or status code 202 Accepted. You will receive a HTTP 202 when the request you are […]

Authenticating with the RESTful API Field Squared uses a RESTful API to send and receive data. This API conforms strongly to the Data Transfer Objects (DTO) pattern designed by Martin Fowler as outlined in Enterprise Integration Patterns. All requests to the Field Squared API must authenticate with the Field Squared […]