Welcome to the FieldInsight API Documentation, Here you will find all current endpoints documented with examples provided. Body data for all requests must be encoded as a query string.
\nAuthenticate through OAuth 2 all grant types are supported. A development account must be requested from FieldInsight for the Client ID/Secret and Redirect URL required to use this API. A guide to using the Development account is found here.
\nThis API requires that all requests with body data(PATCH POST) have that data encoded as a URL encoded string. It's also expected your URL encoded string handles arrays as repeated values. You should be able to find a setting to enable this behaviour in your language of choice e.g. workers=1844&workers=1845 not workers[0]=1844&workers[1]=1845
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"URL Encoded","slug":"url-encoded"}],"owner":"14754452","collectionId":"3af1a496-925d-4ca7-862a-600a6af0fdff","publishedId":"TWDdjDgZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-03-01T22:36:15.000Z"},"item":[{"name":"OAuth 2 flow Example","item":[{"name":"Redirect User","id":"e816c935-6ec3-4f5f-bbae-acbd9fcbd2e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://app.fieldinsight.com/oauth/authorize/?response_type=code&state=random_state&client_id=CLIENT_ID","description":"Redirect the User to this URL to have them log in to FieldInsight. FieldInsight will provide an Authorization code in response.
\n","urlObject":{"host":["https://app.fieldinsight.com/oauth/authorize/"],"query":[{"description":{"content":"Set this to code to get an Authorization Code.
\n","type":"text/plain"},"key":"response_type","value":"code"},{"description":{"content":"Set this to something and FieldInsight will pass it back (Security check).
\n","type":"text/plain"},"key":"state","value":"random_state"},{"description":{"content":"Put your Client ID here.
\n","type":"text/plain"},"key":"client_id","value":"CLIENT_ID"}],"variable":[]}},"response":[],"_postman_id":"e816c935-6ec3-4f5f-bbae-acbd9fcbd2e8"},{"name":"Callback example","id":"b629de31-7d8a-4d0a-ba52-18b2b9386ad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://my-fieldinsight-integration.com/oauth-callback/?state=random_state&code=CODE","description":"Next FieldInsight will send the Customer back to the Callback URL you specified with the Authorization code.
\n","urlObject":{"host":["https://my-fieldinsight-integration.com/oauth-callback/"],"query":[{"description":{"content":"You can make sure the same state has been sent back for increased security.
\n","type":"text/plain"},"key":"state","value":"random_state"},{"description":{"content":"This is your Authorization Code used in the next step to retrieve an Access Code.
\n","type":"text/plain"},"key":"code","value":"CODE"}],"variable":[]}},"response":[],"_postman_id":"b629de31-7d8a-4d0a-ba52-18b2b9386ad6"},{"name":"Request an Access Token","id":"543a8598-3bf7-4673-8800-e67aba782fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"authorization_code","type":"text","description":"We use an Authorization Code for this example.
\n"},{"key":"client_id","value":"CLIENT_ID","type":"text","description":"The Client ID you recieved from FieldInsight.
\n"},{"key":"client_secret","value":"CLIENT_SECRET","type":"text","description":"The Client Secret you recieved from FieldInsight.
\n"},{"key":"code","value":"CODE","type":"text","description":"The Authorization Code from the previous step.
\n"},{"key":"redirect_uri","value":"https://my-fieldinsight-integration.com/oauth-callback/","type":"text","description":"The Callback URL you provided to FieldInsight.
\n"}]},"url":"https://app.fieldinsight.com/oauth/token/","description":"Finally you request an Access Token from FieldInsight using the Authorization Code and Client ID/Secret. Once you have the Access Token you can use it to Access the Rest of the API
\n","urlObject":{"host":["https://app.fieldinsight.com/oauth/token/"],"query":[],"variable":[]}},"response":[],"_postman_id":"543a8598-3bf7-4673-8800-e67aba782fa8"},{"name":"Refreshing an Access Token","id":"516cd0cb-b66b-4d88-ad48-e088eb6bffb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"client_id","value":"CLIENT_ID","description":"The Client ID you recieved from FieldInsight.
\n","type":"text"},{"key":"client_secret","value":"CLIENT_SECRET","description":"The Client Secret you recieved from FieldInsight.
\n","type":"text"},{"key":"refresh_token","value":"REFRESH_TOKEN","description":"The Refresh Token you recieved with the Access Token.
\n","type":"text"}]},"url":"https://app.fieldinsight.com/oauth/token/","description":"Access tokens expire after 10 hours. \nYour app can refresh an access token without user interaction by using a refresh token provided together with the access token.\nTo refresh your access token, make a POST request to the token endpoint with grant_type=refresh_token, and include the refresh token as well as the client credentials.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8f42a5b9-eb5e-4eb1-893b-c7b1ac0c8d47","id":"8f42a5b9-eb5e-4eb1-893b-c7b1ac0c8d47","name":"OAuth 2 flow Example","type":"folder"}},"urlObject":{"host":["https://app.fieldinsight.com/oauth/token/"],"query":[],"variable":[]}},"response":[],"_postman_id":"516cd0cb-b66b-4d88-ad48-e088eb6bffb1"}],"id":"8f42a5b9-eb5e-4eb1-893b-c7b1ac0c8d47","description":"Provided below is an example of the Authorization code OAuth 2 flow. The user is redirected to FieldInsight to login and permit access. Then FieldInsight will redirect the user back to the callback url you specified with an authorization code. Finally the authorization code is traded for an access code which you can use to access the rest of the API
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f7d93307-fc59-46df-990b-ad2e8621b0be","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d2936fa0-84dd-419d-9d1f-64fe609d8ebd","type":"text/javascript","exec":[""]}}],"_postman_id":"8f42a5b9-eb5e-4eb1-893b-c7b1ac0c8d47"},{"name":"Company","item":[{"name":"List Companies","id":"2acba8b7-3f22-4f15-9b98-3abee290f118","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://app.fieldinsight.com/public-api/companies/?id&email&cursor&page_size&external_id","description":"Retrieve one or more Companies.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Find one company by ID.
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"Find one or more companies by email (case insensitive).
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"Start from a specific position, used for pagination.
\n","type":"text/plain"},"key":"cursor","value":null},{"description":{"content":"Number of Results to return (min 1, max 100).
\n","type":"text/plain"},"key":"page_size","value":null},{"description":{"content":"Find one company by external ID.
\n","type":"text/plain"},"key":"external_id","value":null}],"variable":[]}},"response":[{"id":"e6dfb13e-60b9-4c5b-939b-c504ade53add","name":"Find companies by email","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":{"raw":"https://app.fieldinsight.com/public-api/companies/?email=sales@acme.com","host":["https://app.fieldinsight.com/public-api/companies"],"path":[""],"query":[{"key":"email","value":"sales@acme.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"objects\": [\n {\n \"id\": \"432\", // Id\n \"business_name\": \"Acme Corp\", // String(200)\n \"business_number\": \"5341 53242\", // String(50) \n \"mobile_number\": \"9491 570 156\", // String(150)\n \"email\": \"sales@acme.com\", // String(254)\n \"notes\": \"Plumber is installing new baffles.\", // String(10240)\n \"address\": \"4 Fancher Drive Richmond VIC 3121, Australia\" // String(500)\n }\n ...\n ],\n \"next_page_cursor\": \"gt/440\" // Repeat the same query again with cursor paramater set to this value to get the next page.\n}"}],"_postman_id":"2acba8b7-3f22-4f15-9b98-3abee290f118"},{"name":"Create a new Company","id":"bc075bce-5f8c-4380-a104-beda4406eb4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"business_name","value":"","type":"text","description":"Company's name. Example: Acme Corp.
\n"},{"key":"mobile_number","value":"","type":"text","description":"Company's' mobile number. Example: 9491 570 156.
\n"},{"key":"email","value":"","type":"text","description":"Company's email address. Example: sales@acme.com.
\n"},{"key":"business_number","value":"","type":"text","description":"Company's business number. Example: 5341 53242.
\n"},{"key":"address","value":"","description":"Company's address. Example: 4 Fancher Drive Richmond VIC 3121, Australia.
\n","type":"text"},{"key":"notes","value":"","description":"Company's notes. Example: Plumber is installing new baffles.
\n","type":"text"},{"key":"external_id","value":"","description":"Company's external ID. Example: 32f9c7f7-fee7-4b55-a769-06d8b686e850
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/companies/","description":"Create a new Company.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Company's name
\n"},{"key":"mobile_number","value":"","type":"text","description":"Company's mobile number
\n"},{"key":"email","value":"","type":"text","description":"Company's email
\n"},{"key":"business_number","value":"","type":"text","description":"Company's registration number
\n"},{"key":"address","value":"","type":"text","description":"Company's address
\n"},{"key":"notes","value":"","type":"text","description":"Notes
\n"}]},"url":"https://app.fieldinsight.com/public-api/companies/:company_id/","description":"This endpoint allows to update individual fields of an existing company. One or more fields can be updated at once.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Id of the Company to update
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"}]}},"response":[{"id":"d5f37fc1-bdf7-4f00-b874-699143246d1e","name":"Update a Company's name","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"business_name","value":"2342","type":"text","description":"Never Late Electrical"}]},"url":{"raw":"https://app.fieldinsight.com/public-api/companies/:company_id/","host":["https://app.fieldinsight.com/public-api/companies"],"path":[":company_id",""],"variable":[{"key":"company_id","value":"3452","description":"Id of the Company to update"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"404ef148-fb6e-4257-92b4-249d04d35bd3"}],"id":"284aa813-e952-4a8f-83ab-6d375a844a95","description":"Endpoints for working with Companies
\n","event":[{"listen":"prerequest","script":{"id":"0eaefa7e-19ec-42a4-88c3-175feef06df5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f11dd7ff-58b0-4269-9c52-166a76d39e2a","type":"text/javascript","exec":[""]}}],"_postman_id":"284aa813-e952-4a8f-83ab-6d375a844a95","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Retrieve one or more Sites.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Find one site by ID.
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"Find one or more sites by email (case insensitive).
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"Start from a specific position, Used for pagination.
\n","type":"text/plain"},"key":"cursor","value":null},{"description":{"content":"Number of Results to return (min 1, max 100).
\n","type":"text/plain"},"key":"page_size","value":null},{"description":{"content":"Order the ENTIRE set before pulling n=page_size from the top. 'name_asc' to sort by name ascending(a-z) or 'creation_time_desc' to sort reverse chronologically(2000-1990)
\n","type":"text/plain"},"key":"order","value":null}],"variable":[]}},"response":[{"id":"44ea0dec-410c-4567-9fc5-23bcb23dad27","name":"Find one site by ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":{"raw":"https://app.fieldinsight.com/public-api/sites/?id=552","host":["https://app.fieldinsight.com/public-api/sites"],"path":[""],"query":[{"key":"id","value":"552"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"objects\": [\n {\n \"id\": \"552\",\n \"first_name\": \"Chloe\", // String(50)\n \"last_name\": \"Ormsby\", // String(50)\n \"business_name\": \"Acme Corp\", // String(200)\n \"mobile_number\": \"9491 570 156\", // String(150)\n \"email\": \"chloe@gmail.com\", // String(254)\n \"notes\": \"The key is under the mat\", // String(10240)\n \"url\": \"https://www.instagram.com/chloe199812/\", // String(1024)\n \"address\": \"15 Madison Ave Richmond VIC 3121, Australia\" // String(500)\n }\n ...\n ],\n \"next_page_cursor\": \"gt/642\" // Repeat the same query again with cursor paramater set to this value to get the next page.\n}"}],"_postman_id":"c86085bf-d87b-4305-8c15-ac72456948b1"},{"name":"Create a new Site","id":"c7793184-cf56-44aa-b59e-867a6193ce88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"first_name","value":"","type":"text","description":"Site's contact's first name. Example: Chloe.
\n"},{"key":"last_name","value":"","type":"text","description":"Site's contact's last name. Example: Ormsby.
\n"},{"key":"business_name","value":"","type":"text","description":"Site's Business's name. Example: Acme Corp
\n"},{"key":"company","value":"","type":"text","description":"Site's Company's ID.
\n"},{"key":"mobile_number","value":"","type":"text","description":"Site's contact's mobile number. Example: 9491 570 156.
\n"},{"key":"email","value":"","type":"text","description":"Site's contact's email. Example: chloe@gmail.com.
\n"},{"key":"notes","value":"","type":"text","description":"Site's notes. Example: The key is under the mat.
\n"},{"key":"address","value":"","type":"text","description":"Site's address. Example: 15 Madison Ave Richmond VIC 3121, Australia.
\n"},{"key":"url","value":"","type":"text","description":"Site's URL. https://www.instagram.com/chloe199812/
\n"},{"key":"external_id","value":"","description":"Site's external ID.
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/sites/","description":"Create a new Site.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Site's contact's first name.
\n"},{"key":"last_name","value":"","type":"text","description":"Site's contact's last name.
\n"},{"key":"business_name","value":"","type":"text","description":"Site's business's name.
\n"},{"key":"company","value":"","type":"text","description":"Site's Company's ID.
\n"},{"key":"mobile_number","value":"","type":"text","description":"Site's contact's mobile number.
\n"},{"key":"email","value":"","type":"text","description":"Site's contact's email.
\n"},{"key":"notes","value":"","type":"text","description":"Site's notes.
\n"},{"key":"address","value":"","type":"text","description":"Site's address.
\n"},{"key":"url","value":"","type":"text","description":"Site's URL.
\n"},{"key":"external_id","value":"","description":"Site's external ID
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/sites/:site_id/","description":"This endpoint allows to update individual fields of an existing Site. One or more fields can be updated at once.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Id of the Site to update
\n","type":"text/plain"},"type":"any","value":"","key":"site_id"}]}},"response":[{"id":"7491095c-dc9d-42f8-9a37-0de487fbbe03","name":"Update a Site's address","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"address","value":"198 Shirley Street PIMPAMA QLD 4209","type":"text"}]},"url":{"raw":"https://app.fieldinsight.com/public-api/sites/:site_id/","host":["https://app.fieldinsight.com/public-api/sites"],"path":[":site_id",""],"variable":[{"key":"site_id","value":"8313","description":"Id of the Site to update"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a798bf6b-14c0-4b55-8a86-2f93516e289a"}],"id":"1b5211a0-f89f-4431-8da3-e6e70c397c9d","description":"Endpoints for working with Sites
\n","event":[{"listen":"prerequest","script":{"id":"c5663016-5152-4cd8-806b-2d16933d2b8c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"905666a1-1f3e-408b-adc0-98a96b54f528","type":"text/javascript","exec":[""]}}],"_postman_id":"1b5211a0-f89f-4431-8da3-e6e70c397c9d","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Retrieve one or more Job statuses.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Find one Job Status by name, exact match (case sensitive).
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"Start from a specific position, used for pagination.
\n","type":"text/plain"},"key":"cursor","value":null},{"description":{"content":"Number of Results to return (min 1, max 100).
\n","type":"text/plain"},"key":"page_size","value":null},{"description":{"content":"Order the ENTIRE set before pulling n=page_size from the top. 'name_asc' to sort by name ascending(a-z) or 'creation_time_desc' to sort reverse chronologically(2000-1990)
\n","type":"text/plain"},"key":"order","value":null}],"variable":[]}},"response":[{"id":"5a9a6290-14c4-449f-a607-b19569c774c9","name":"Find a status by name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":{"raw":"https://app.fieldinsight.com/public-api/job-statuses/?name=Scheduled","host":["https://app.fieldinsight.com/public-api/job-statuses"],"path":[""],"query":[{"key":"name","value":"Scheduled"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"next_page_cursor\": null,\n \"objects\": [\n {\n \"id\": 772,\n \"name\": \"Scheduled\"\n }\n ]\n}"}],"_postman_id":"6d864a78-e659-4059-af42-d64c883bd6eb"},{"name":"List Job Types","id":"e98589bf-73e1-4c86-b435-ea21acd16b91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://app.fieldinsight.com/public-api/job-types/?name&cursor&page_size&order","description":"Retrieve one or more Job types.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Find one Job Type by name, exact match (case sensitive).
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"Start from a specific position, Used for pagination.
\n","type":"text/plain"},"key":"cursor","value":null},{"description":{"content":"Number of Results to return (min 1, max 100).
\n","type":"text/plain"},"key":"page_size","value":null},{"description":{"content":"Order the ENTIRE set before pulling n=page_size from the top. 'name_asc' to sort by name ascending(a-z) or 'creation_time_desc' to sort reverse chronologically(2000-1990)
\n","type":"text/plain"},"key":"order","value":null}],"variable":[]}},"response":[{"id":"6cf30404-128e-4241-b985-2f14fa1eed90","name":"Find a job type by name","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":{"raw":"https://app.fieldinsight.com/public-api/job-types/?name=Installation","host":["https://app.fieldinsight.com/public-api/job-types"],"path":[""],"query":[{"key":"name","value":"Installation"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"next_page_cursor\": null,\n \"objects\": [\n {\n \"id\": 1,\n \"name\": \"Installation\"\n }\n ]\n}"}],"_postman_id":"e98589bf-73e1-4c86-b435-ea21acd16b91"},{"name":"List Jobs","id":"ef37bc4f-08d2-4038-afd7-f7e7f54453c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://app.fieldinsight.com/public-api/jobs/?id&time_from&time_to&site&company&status&cursor&page_size&updated_from&updated_to&external_id","description":"Retrieve one or more Jobs.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Find one job by ID.
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"Only include jobs that overlap in time with an interval starting at this time.
\n","type":"text/plain"},"key":"time_from","value":null},{"description":{"content":"Only include jobs that overlap in time with an interval ending at this time.
\n","type":"text/plain"},"key":"time_to","value":null},{"description":{"content":"Only include jobs that have a site with this ID.
\n","type":"text/plain"},"key":"site","value":null},{"description":{"content":"Only include jobs that have a site with this company ID.
\n","type":"text/plain"},"key":"company","value":null},{"description":{"content":"Only include jobs in a status with this ID.
\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"Start from a specific position, used for pagination.
\n","type":"text/plain"},"key":"cursor","value":null},{"description":{"content":"Number of Results to return (min 1, max 100).
\n","type":"text/plain"},"key":"page_size","value":null},{"description":{"content":"Only include jobs that were updated last time on or after this time in UTC timezone.
\n","type":"text/plain"},"key":"updated_from","value":null},{"description":{"content":"Only include jobs that were updated last time before this time in UTC timezone.
\n","type":"text/plain"},"key":"updated_to","value":null},{"description":{"content":"Only include jobs with this external ID.
\n","type":"text/plain"},"key":"external_id","value":null}],"variable":[]}},"response":[{"id":"d07996ca-5714-4241-858f-accc545832fb","name":"Find jobs in a time range","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/?time_from=2009-05-12T00:00:00&time_to=2009-05-13T00:00:00","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[""],"query":[{"key":"time_from","value":"2009-05-12T00:00:00"},{"key":"time_to","value":"2009-05-13T00:00:00"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"10342\",\n \"printable_number\": \"0-14\",\n \"start_time\": \"2009-05-12T02:30:00Z\",\n \"end_time\": \"2009-05-12T03:00:00Z\",\n \"site\": {\n \"id\": \"172\",\n \"address\": \"1629 Bens Hill Rd, Koongawa SA 5650, Australia\"\n },\n \"status\": {\n \"id\": \"772\",\n \"name\": \"Scheduled\"\n },\n \"job_types\": [\n {\n \"id\": \"221\",\n \"name\": \"Installation\"\n },\n {\n \"id\": \"223\",\n \"name\": \"Repairs\"\n }\n ],\n \"workers\": [\n {\n \"id\": \"3312\",\n \"name\": \"Grayson Keller\"\n },\n {\n \"id\": \"5432\",\n \"name\": \"Oswald Young\"\n }\n ],\n \"creator\": {\n \"id\": \"1442\",\n \"name\": \"Jack Wilcher\"\n },\n \"created_at\": \"2009-05-01T10:05:00Z\", // Time in UTC timezone\n \"updated_at\": \"2009-05-01T11:05:00Z\", // Time in UTC timezone\n \"timesheet_hrs\": \"0.5\",\n \"custom_fields\": [\n {\n \"id\": \"3442\",\n \"field_type\": \"text\",\n \"name\": \"Warranty Number\",\n \"value\": \"G3A110215-1EQFA\"\n },\n {\n \"id\": \"6631\",\n \"field_type\": \"textarea\",\n \"name\": \"Completion Notes\",\n \"value\": \"Verified sufficient power from sub-panel.\"\n },\n {\n \"id\": \"5132\",\n \"field_type\": \"date\",\n \"name\": \"Tentative Booked Date\",\n \"value\": \"2009-05-12\"\n },\n {\n \"id\": \"5244\",\n \"field_type\": \"time\",\n \"name\": \"On Site Time\",\n \"value\": \"02:34:00\"\n },\n {\n \"id\": \"4544\",\n \"field_type\": \"checkbox\",\n \"name\": \"Have Parts Been Ordered?\",\n \"value\": true\n },\n {\n \"id\": \"3251\",\n \"field_type\": \"phone\",\n \"name\": \"Additional Phone number\",\n \"value\": \"0432 510 738\"\n },\n {\n \"id\": \"6766\",\n \"field_type\": \"select\",\n \"name\": \"Instal Type\",\n \"value\": {\n \"id\": \"3651\",\n \"name\": \"Side to Back\"\n }\n },\n {\n \"id\": \"6767\",\n \"field_type\": \"multiselect\",\n \"name\": \"Site Checks\",\n \"value\": [\n {\n \"id\": \"3953\",\n \"name\": \"All staff have checked in\"\n },\n {\n \"id\": \"3954\",\n \"name\": \"All tools accounted for\"\n }\n ]\n }\n ],\n \"total_purchase_price_inc_tax\": \"321.00\",\n \"total_sales_price_ex_tax\": \"450.00\"\n }\n]"}],"_postman_id":"ef37bc4f-08d2-4038-afd7-f7e7f54453c9"},{"name":"List Job Inventory","id":"e0d8c5f2-b0a7-411d-b8f7-d5d387d78695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://app.fieldinsight.com/public-api/jobs/:job_id/inventory/","description":"Retrieve Job inventory.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Id of the Job
\n","type":"text/plain"},"type":"any","value":"","key":"job_id"}]}},"response":[{"id":"f5ea04ce-c3b5-4464-a129-5a32e9754eca","name":"Find a job Inventory","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/:job_id/inventory/","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[":job_id","inventory",""],"variable":[{"key":"job_id","value":"1121","description":"Id of the Job"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"line_items\":[\n {\n \"inv_type\":\"part\",\n \"item_code\":{\n \"id\":\"10\",\n \"external_id\":\"ITM0000001\",\n \"name\":\"ITM0000001\"\n },\n \"uom\":null,\n \"cost_code\":{\n \"id\":\"1\",\n \"external_id\":\"0000\",\n \"code\":\"0000\"\n },\n \"account_group\":null,\n \"description\":\"Standard Keyboard\",\n \"tax\":\"tax\",\n \"estimated_hours_per_day\":\"1\",\n \"work_duration_in_days\":1,\n \"coverage_qty\":\"0\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"sales_unit_price\":\"0\",\n \"sales_sub_total\":\"0\",\n \"sales_tax_amount\":\"0\",\n \"sales_total_inc_tax\":\"0\",\n \"purchase_unit_price\":\"0\",\n \"purchase_sub_total\":\"0\",\n \"purchase_tax_amount\":\"0\",\n \"purchase_total_inc_tax\":\"0\",\n \"location\":{\n \"external_id\":\"\"\n }\n },\n {\n \"inv_type\":\"part\",\n \"item_code\":{\n \"id\":\"60\",\n \"external_id\":\"ELE32LED\",\n \"name\":\"ELE32LED\"\n },\n \"uom\":null,\n \"cost_code\":{\n \"id\":\"2\",\n \"external_id\":\"44 3\",\n \"code\":\"44 3\"\n },\n \"account_group\":null,\n \"description\":\"Sam 32-Inch LED HDTV\",\n \"tax\":\"tax\",\n \"estimated_hours_per_day\":\"1\",\n \"work_duration_in_days\":1,\n \"coverage_qty\":\"0\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"sales_unit_price\":\"565.95\",\n \"sales_sub_total\":\"565.95\",\n \"sales_tax_amount\":\"56.6\",\n \"sales_total_inc_tax\":\"622.55\",\n \"purchase_unit_price\":\"0\",\n \"purchase_sub_total\":\"0\",\n \"purchase_tax_amount\":\"0\",\n \"purchase_total_inc_tax\":\"0\",\n \"location\":{\n \"external_id\":\"\"\n }\n }\n ],\n \"tax_rate\":\"10\",\n \"sales_tax_base\":\"exclusive\",\n \"sales_sub_total\":\"565.95\",\n \"sales_tax_amount\":\"56.6\",\n \"total_sales_price_ex_tax\":\"565.95\",\n \"total_sales_price_inc_tax\":\"622.55\",\n \"purchase_tax_base\":\"exclusive\",\n \"purchase_sub_total\":\"0\",\n \"total_purchase_price_inc_tax\":\"0\"\n}"}],"_postman_id":"e0d8c5f2-b0a7-411d-b8f7-d5d387d78695"},{"name":"Create a new Job","id":"15492226-1826-45b8-ac56-fde3e17d5220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"start_time","value":"","type":"text","description":"Job's start date/time. Example: 2021-02-12T09:00:00.
\n"},{"key":"end_time","value":"","type":"text","description":"Job's end date/time. Example: 2021-02-12T10:00:00.
\n"},{"key":"unscheduled","value":"","type":"text","description":"Create an unscheduled Job. Must be set to True.
\n"},{"key":"status","value":"","type":"text","description":"Job's status ID
\n"},{"key":"site","value":"","type":"text","description":"Job's site ID
\n"},{"key":"job_types","value":"","type":"text","description":"Job's job type IDs
\n"},{"key":"job_notes","value":"","type":"text","description":"Job's notes
\n"},{"key":"purchase_order_number","value":"","description":"Job's purchase order number
\n","type":"text"},{"key":"workers","value":"","description":"Worker IDs to assign to this job
\n","type":"text"},{"key":"external_id","value":"","description":"Job's external ID
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/jobs/","description":"Create a new Job.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Job's start date/time. Example: 2021-02-12T09:00:00.
\n"},{"key":"end_time","value":"","type":"text","description":"Job's end date/time. Example: 2021-02-12T10:00:00.
\n"},{"key":"status","value":"","type":"text","description":"Job's status ID
\n"},{"key":"site","value":"","type":"text","description":"Job's site ID
\n"},{"key":"job_types","value":"","type":"text","description":"Job's job type IDs
\n"},{"key":"job_notes","value":"","type":"text","description":"Job's notes
\n"},{"key":"purchase_order_number","value":"","description":"Job's purchase order number
\n","type":"text"},{"key":"workers","value":"","description":"Worker IDs to assign to this job
\n","type":"text"},{"key":"external_id","value":"","description":"Job's external ID
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/jobs/:job_id/","description":"This endpoint allows to update individual fields of an existing Job. One or more fields can be updated at once.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Id of the Job to update
\n","type":"text/plain"},"type":"any","value":"","key":"job_id"}]}},"response":[{"id":"d60f0e5c-17ec-44af-a659-76eb6bfdd153","name":"Update a Job's time","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"start_time","value":"2021-02-12T14:00:00","type":"text","description":"Job's start date/time. Example: 2021-02-12T09:00:00."},{"key":"end_time","value":"2021-02-12T15:00:00","type":"text","description":"Job's end date/time. Example: 2021-02-12T10:00:00."}]},"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/:job_id/","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[":job_id",""],"variable":[{"key":"job_id","value":"7740","description":"Id of the Job to update"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"961194e7-2ee5-4659-b780-d41281e87753","name":"Update a Job's purchase order number","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"purchase_order_number","value":"0002","description":"Job's purchase order number","type":"text"}]},"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/:job_id/","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[":job_id",""],"variable":[{"key":"job_id","value":"7740","description":"Id of the Job to update"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"56c9b293-894c-4ffa-89c4-7cd6e5af7afc","name":"Assign workers to a job","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"start_time","value":"","type":"text","description":"Job's start date/time. Example: 2021-02-12T09:00:00.","disabled":true},{"key":"end_time","value":"","type":"text","description":"Job's end date/time. Example: 2021-02-12T10:00:00.","disabled":true},{"key":"status","value":"","type":"text","description":"Job's status ID","disabled":true},{"key":"site","value":"","type":"text","description":"Job's site ID","disabled":true},{"key":"job_types","value":"","type":"text","description":"Job's job type IDs","disabled":true},{"key":"job_notes","value":"","type":"text","description":"Job's notes","disabled":true},{"key":"purchase_order_number","value":"","description":"Job's purchase order number","type":"text","disabled":true},{"key":"workers","value":"1844","description":"Worker IDs to assign to this job","type":"text"}]},"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/:job_id/","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[":job_id",""],"variable":[{"key":"job_id","value":"","description":"Id of the Job to update"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"11703f5b-6fc6-42da-90b3-cdbd9f46e536"},{"name":"Upload a file to a Job","id":"1c80123a-0e52-4bcf-aad9-d783d861aa12","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept-encoding":true,"user-agent":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"},{"key":"Content-Length","value":"","description":"Size of the file
\n","type":"text"},{"key":"Content-Type","value":"","description":"MIME type of the file (Use application/octet-stream if type is unknown)
\n","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"https://app.fieldinsight.com/public-api/jobs/:job_id/attachments/upload/?name=","description":"This endpoint allows to upload a file and attach it to a job.\nThe maximum file size that can be uploaded through the API is 10 MB.
\nTo upload a file make a POST request with the file size specified in the Content-Length header, the file name specified in the name parameter of the query and the file contents in the request body.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Name of the file
\n","type":"text/plain"},"key":"name","value":""}],"variable":[{"description":{"content":"Id of the job to attach the file to
\n","type":"text/plain"},"type":"any","value":"","key":"job_id"}]}},"response":[{"id":"731554e5-cfc3-4a53-954d-052475c59c5d","name":"Upload a file using curl","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"},{"key":"Content-Length","value":"2464","description":"Size of the file","type":"text"},{"key":"Content-Type","value":"image/png","description":"MIME type of the file","type":"text"}],"body":{"mode":"file","file":{"src":"r_PFVlby7/example.png"}},"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/:job_id/attachments/upload/?name=example.png","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[":job_id","attachments","upload",""],"query":[{"key":"name","value":"example.png","description":"Name of the file"}],"variable":[{"key":"job_id","value":"3432","description":"Id of the job to attach the file to"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"File uploaded successfully.\"\n}"}],"_postman_id":"1c80123a-0e52-4bcf-aad9-d783d861aa12"}],"id":"0c28e195-2b6f-45d5-857c-41215a62390f","description":"Endpoints for working with Jobs
\n","_postman_id":"0c28e195-2b6f-45d5-857c-41215a62390f","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Only include assets with this ID.
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"Only include assets that were updated last time on or after this time in UTC timezone.
\n","type":"text/plain"},"key":"updated_from ","value":null},{"description":{"content":"Only include assets that were updated last time before this time in UTC timezone.
\n","type":"text/plain"},"key":"updated_to","value":null}],"variable":[]}},"response":[{"id":"cfd18c07-61e9-466c-a1ae-dd9339e86fec","name":"List Assets","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":{"raw":"https://app.fieldinsight.com/public-api/assets/?id&updated_from &updated_to","host":["https://app.fieldinsight.com/public-api/assets"],"path":[""],"query":[{"key":"id","value":null,"description":"Only include assets with this ID."},{"key":"updated_from ","value":null,"description":"Only include assets that were updated last time on or after this time in UTC timezone. "},{"key":"updated_to","value":null,"description":"Only include assets that were updated last time before this time in UTC timezone."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"next_page_cursor\": null,\n \"prev_page_cursor\": null,\n \"objects\": [\n {\n \"id\": \"184433\",\n \"custom_id\": \"4542w34\",\n \"serial_number\": \"serial_number\",\n \"qty\": 1,\n \"asset_type\": {\n \"id\": \"1760\",\n \"name\": \"Type 1\"\n },\n \"model\": {\n \"id\": \"20023\",\n \"name\": \"model_number\"\n },\n \"created_at\": \"2009-05-01T10:05:00Z\", // Time in UTC timezone\n \"updated_at\": \"2009-05-01T11:05:00Z\", // Time in UTC timezone\n \"custom_fields\": [\n {\n \"id\": \"1432\",\n \"field_type\": \"text\",\n \"name\": \"Warranty Number\",\n \"value\": \"G3A110215-1EQFA\"\n },\n {\n \"id\": \"7242\",\n \"field_type\": \"text\",\n \"name\": \"Pressure\",\n \"value\": \"278\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"71377d7e-7db6-4442-bc78-3bfc148d61ca"},{"name":"List Asset types","id":"fd842e11-40f9-4708-8c97-6afd5514e145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://app.fieldinsight.com/public-api/asset-types/","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"See examples for usage
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/assets/","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"See examples for usage
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/assets/ASSET_ID/","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Job ID
\n","type":"text/plain"},"type":"any","value":null,"key":"job_id"},{"description":{"content":"Asset ID
\n","type":"text/plain"},"type":"any","value":null,"key":"asset_id"}]}},"response":[{"id":"c36c52cf-283f-4196-99cc-a4e153334703","name":"Remove asset from Job","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/:job_id/assets/:asset_id/","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[":job_id","assets",":asset_id",""],"variable":[{"key":"job_id","value":"10146777","description":"Job ID"},{"key":"asset_id","value":"184433","description":"Asset ID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2c26411e-360b-4f00-8ec9-fde352965929"},{"name":"List Assets selected on jobs","id":"0924fc6e-f452-4b38-87f2-2ee56c7f0d59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://app.fieldinsight.com/public-api/jobs/assets/?job=","description":"This endpoint returns assets marked as 'used' on jobs.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Only include assets selected on a job with this ID. This parameter can be specified more than once.
\n","type":"text/plain"},"key":"job","value":""}],"variable":[]}},"response":[{"id":"20060bc3-9089-4557-a745-0c29f452bc70","name":"List Job Assets","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/assets/?job=6711","host":["https://app.fieldinsight.com/public-api/jobs"],"path":["assets",""],"query":[{"key":"job","value":"6711"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"next_page_cursor\": null,\n \"objects\": [\n {\n \"id\": 1432, // asset's id\n \"job_id\": \"6711\", // job's id\n \"custom_id\": \"A-1432\" // asset's custom id\n },\n {\n \"id\": 1433,\n \"job_id\": \"6711\",\n \"custom_id\": \"A-1433\"\n }\n ]\n}"}],"_postman_id":"0924fc6e-f452-4b38-87f2-2ee56c7f0d59"},{"name":"Add asset to Job","id":"57f6da99-1c73-449a-b85a-bcb05ef5e2ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"asset","value":"","description":"Asset ID
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/jobs/:job_id/assets/","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Job ID
\n","type":"text/plain"},"type":"any","value":null,"key":"job_id"}]}},"response":[{"id":"61d106f2-36d8-494f-a08a-6b5d778e1cb8","name":"Add asset to Job","originalRequest":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"asset","value":"184433","description":"Asset ID","type":"text"}]},"url":{"raw":"https://app.fieldinsight.com/public-api/jobs/:job_id/assets/","host":["https://app.fieldinsight.com/public-api/jobs"],"path":[":job_id","assets",""],"variable":[{"key":"job_id","value":"10146777","description":"Job ID"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"57f6da99-1c73-449a-b85a-bcb05ef5e2ba"}],"id":"a6ffe621-91ce-4db7-8e7c-5ae1e8cd0ef1","_postman_id":"a6ffe621-91ce-4db7-8e7c-5ae1e8cd0ef1","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Returns fields describing the business.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Information describing the business account the API client connected to.
\n","_postman_id":"ef411c2c-579f-4816-9e3f-41fa13e74b49","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"A unique identifier of the asset (required). Max length is 36 characters.
\n","type":"text"},{"key":"inv_type","value":"","description":"Type of the inventory item, e.g., service, part (required).
\n","type":"text"},{"key":"code","value":"","description":"Name of the item. Single line, max length is 255 characters.
\n","type":"text"},{"key":"sales","value":"","description":"Sales price of the item in the decimal format. Example: 100.42.
\n","type":"text"},{"key":"purchase","value":"","description":"Purchase price of the item in the decimal format. Example: 90.87.
\n","type":"text"},{"key":"description","value":"","description":"Description of the item. Multiline, max length is 2000 characters.
\n","type":"text"}]},"url":"https://app.fieldinsight.com/public-api/inventory/","description":"This andpoint allows to either create or update an Inventory Item identified by external_id. It looks for an item matching to specified external_id and updates it if found. If not found creates a new Item. Returns internal id of the item in Fieldinsight.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Returns fields describing the Invoice.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Id of the Invoice
\n","type":"text/plain"},"type":"any","value":"111","key":"invoice_id"}]}},"response":[{"id":"b52f9bb6-16ce-45ba-8c8c-ce1a569dec6f","name":"Get Invoice details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Ym9zY236Ym9zY28="}],"url":"https://app.fieldinsight.com/public-api/invoices/222/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\":\"11\",\n \"printable_number\":\"INV-0001\",\n \"title\":\"Invoice 1\",\n \"created_at\":\"2024-01-19T20:38:03+1100\",\n \"updated_at\":\"2024-03-20T18:54:25+1100\",\n \"site\":null,\n \"project\":{\n \"id\": 1,\n \"number\": 1\n \"external_id\": \"PR000001\"\n },\n \"workflow\":{\n \"id\":\"1\",\n \"name\":\"Service\"\n },\n \"business_area\":null,\n \"business_division\":null,\n \"jobs\":[\n \n ],\n \"sub_total\":\"300\",\n \"tax_amount\":\"30\",\n \"total\":\"330\",\n \"sections\":[\n {\n \"description\":\"\",\n \"allotted_budget\":\"0\",\n \"line_items\":[\n {\n \"sales_price\":\"200\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"Standard Keyboard\",\n \"item_code\":{\n \"id\":\"10\",\n \"external_id\":\"ITM0000001\",\n \"name\":\"ITM0000001\"\n },\n \"location\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"type\":\"warehouse\",\n \"name\":\"Warehouse\"\n },\n \"job\":null\n },\n {\n \"sales_price\":\"100\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"\",\n \"item_code\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"name\":\"Electrical Labour\"\n },\n \"location\":null,\n \"job\":null\n }\n ]\n }\n ],\n \"recipient\":{\n \"id\": 10,\n \"type\": \"site\",\n \"name\": \"John Smith\"\n },\n \"status\":\"draft\",\n \"date\":\"2024-01-19\",\n \"due_date\": \"2024-01-31\",\n \"paid_date\": \"2024-01-25\",\n \"paid_amount\": 100,\n \"owing_amount\": 0,\n \"purchase_order_number\": \"PO0001\",\n}"}],"_postman_id":"ddc2f71a-3f72-4b62-80a9-d11f40d2ae97"},{"name":"Get Invoice list","id":"d2930efd-165e-496b-83e8-9308734c9367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN"}],"url":"https://app.fieldinsight.com/public-api/invoices/?update_from=2024-01-01T00:00:00&update_to=2024-01-01T23:59:59&external_id=000001&job_visit=111","description":"Returns fields describing the Invoice.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Only include documents that were updated last time on or after this time in UTC timezone.
\n","type":"text/plain"},"key":"update_from","value":"2024-01-01T00:00:00"},{"description":{"content":"Only include documents that were updated last time before this time in UTC timezone.
\n","type":"text/plain"},"key":"update_to","value":"2024-01-01T23:59:59"},{"description":{"content":"Only include documents with this exiternal_id.
\n","type":"text/plain"},"key":"external_id","value":"000001"},{"description":{"content":"Only include documents that are associated with the specified job visit.
\n","type":"text/plain"},"key":"job_visit","value":"111"}],"variable":[]}},"response":[{"id":"2be37ea1-f332-4a45-b5f3-a97393e8fdf8","name":"Get Invoices","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Ym9zY236Ym9zY28="}],"url":"https://app.fieldinsight.com/public-api/invoices/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\":\"11\",\n \"printable_number\":\"INV-0001\",\n \"title\":\"Invoice 1\",\n \"created_at\":\"2024-01-19T20:38:03+1100\",\n \"updated_at\":\"2024-03-20T18:54:25+1100\",\n \"site\":null,\n \"project\":{\n \"id\": 1,\n \"number\": 1,\n \"external_id\": \"PR000001\"\n },\n \"workflow\":{\n \"id\":\"1\",\n \"name\":\"Service\"\n },\n \"business_area\":null,\n \"business_division\":null,\n \"jobs\":[\n \n ],\n \"sub_total\":\"300\",\n \"tax_amount\":\"30\",\n \"total\":\"330\",\n \"sections\":[\n {\n \"description\":\"\",\n \"allotted_budget\":\"0\",\n \"line_items\":[\n {\n \"sales_price\":\"200\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"Standard Keyboard\",\n \"item_code\":{\n \"id\":\"10\",\n \"external_id\":\"ITM0000001\",\n \"name\":\"ITM0000001\"\n },\n \"location\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"type\":\"warehouse\",\n \"name\":\"Warehouse\"\n },\n \"job\":null\n },\n {\n \"sales_price\":\"100\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"\",\n \"item_code\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"name\":\"Electrical Labour\"\n },\n \"location\":null,\n \"job\":null\n }\n ]\n }\n ],\n \"recipient\":{\n \"id\": 10,\n \"type\": \"site\",\n \"name\": \"John Smith\"\n },\n \"status\":\"draft\",\n \"date\":\"2024-01-19\",\n \"due_date\": \"2024-01-31\",\n \"paid_date\": \"2024-01-25\",\n \"paid_amount\": 100,\n \"owing_amount\": 0,\n \"purchase_order_number\": \"PO0001\"\n }\n]"}],"_postman_id":"d2930efd-165e-496b-83e8-9308734c9367"},{"name":"Get Invoice PDF","id":"fe6cdb50-21d5-4094-8c1b-1c414fbe8027","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://app.fieldinsight.com/public-api/invoices/:invoice_id/pdf/","description":"This endpoint generates a PDF document. It returns a response with status 302 and a url of the generated file in the Location header.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Returns fields describing the Quote.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Id of the Quote
\n","type":"text/plain"},"type":"any","value":"111","key":"quote_id"}]}},"response":[{"id":"d775c949-c3b6-4c47-b505-fc9fe927e65f","name":"Get Quote details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Ym9zY236Ym9zY28="}],"url":"https://app.fieldinsight.com/public-api/quotes/11/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\":\"11\",\n \"printable_number\":\"QUO-0001\",\n \"title\":\"\",\n \"created_at\":\"2024-01-19T20:38:03+1100\",\n \"updated_at\":\"2024-03-20T18:54:25+1100\",\n \"site\":null,\n \"project\":null,\n \"workflow\":{\n \"id\":\"1\",\n \"name\":\"Service\"\n },\n \"business_area\":null,\n \"business_division\":null,\n \"jobs\":[\n \n ],\n \"sub_total\":\"300\",\n \"tax_amount\":\"30\",\n \"total\":\"330\",\n \"sections\":[\n {\n \"description\":\"\",\n \"allotted_budget\":\"0\",\n \"line_items\":[\n {\n \"sales_price\":\"200\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"Standard Keyboard\",\n \"item_code\":{\n \"id\":\"10\",\n \"external_id\":\"ITM0000001\",\n \"name\":\"ITM0000001\"\n },\n \"location\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"type\":\"warehouse\",\n \"name\":\"Warehouse\"\n },\n \"job\":null\n },\n {\n \"sales_price\":\"100\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"\",\n \"item_code\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"name\":\"Electrical Labour\"\n },\n \"location\":null,\n \"job\":null\n }\n ]\n }\n ],\n \"recipient\":null,\n \"status\":\"draft\",\n \"date\":\"2024-01-19\",\n \"accepted_date\":null,\n \"expected_start_date\":null,\n \"markup\":\"100\"\n}"}],"_postman_id":"a68c5cbf-c050-446a-9b23-190241a01039"},{"name":"Get Quote list","id":"d8614f91-a680-4bd6-bb48-22317b929762","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN"}],"url":"https://app.fieldinsight.com/public-api/quotes/?update_from=2024-01-01T00:00:00&update_to=2024-01-01T23:59:59&external_id=000001&job_visit=111","description":"Returns fields describing the Quote.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Only include documents that were updated last time on or after this time in UTC timezone.
\n","type":"text/plain"},"key":"update_from","value":"2024-01-01T00:00:00"},{"description":{"content":"Only include documents that were updated last time before this time in UTC timezone.
\n","type":"text/plain"},"key":"update_to","value":"2024-01-01T23:59:59"},{"description":{"content":"Only include documents with this exiternal_id.
\n","type":"text/plain"},"key":"external_id","value":"000001"},{"description":{"content":"Only include documents that are associated with the specified job visit.
\n","type":"text/plain"},"key":"job_visit","value":"111"}],"variable":[]}},"response":[{"id":"81e400c1-7bc3-4c03-9c74-de67872f2cfd","name":"Get Quotes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Ym9zY236Ym9zY28="}],"url":"https://app.fieldinsight.com/public-api/quotes/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\":\"11\",\n \"printable_number\":\"QUO-0001\",\n \"title\":\"\",\n \"created_at\":\"2024-01-19T20:38:03+1100\",\n \"updated_at\":\"2024-03-20T18:54:25+1100\",\n \"site\":null,\n \"project\":null,\n \"workflow\":{\n \"id\":\"1\",\n \"name\":\"Service\"\n },\n \"business_area\":null,\n \"business_division\":null,\n \"jobs\":[\n \n ],\n \"sub_total\":\"300\",\n \"tax_amount\":\"30\",\n \"total\":\"330\",\n \"sections\":[\n {\n \"description\":\"\",\n \"allotted_budget\":\"0\",\n \"line_items\":[\n {\n \"sales_price\":\"200\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"Standard Keyboard\",\n \"item_code\":{\n \"id\":\"10\",\n \"external_id\":\"ITM0000001\",\n \"name\":\"ITM0000001\"\n },\n \"location\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"type\":\"warehouse\",\n \"name\":\"Warehouse\"\n },\n \"job\":null\n },\n {\n \"sales_price\":\"100\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"\",\n \"item_code\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"name\":\"Electrical Labour\"\n },\n \"location\":null,\n \"job\":null\n }\n ]\n }\n ],\n \"recipient\":null,\n \"status\":\"draft\",\n \"date\":\"2024-01-19\",\n \"accepted_date\":null,\n \"expected_start_date\":null,\n \"markup\":\"100\"\n }\n]"}],"_postman_id":"d8614f91-a680-4bd6-bb48-22317b929762"}],"id":"b2a3ba25-1031-4ea0-bb66-efa324164904","_postman_id":"b2a3ba25-1031-4ea0-bb66-efa324164904","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Returns fields describing the Invoice.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Id of the Report
\n","type":"text/plain"},"type":"any","value":"","key":"report_id"}]}},"response":[{"id":"16a62beb-17e3-4436-baa3-163fe75311ff","name":"Get Report details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Ym9zY236Ym9zY28="}],"url":"https://app.fieldinsight.com/public-api/reports/222/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\":\"11\",\n \"printable_number\":\"REP-0001\",\n \"title\":\"Report 1\",\n \"created_at\":\"2024-01-19T20:38:03+1100\",\n \"updated_at\":\"2024-03-20T18:54:25+1100\",\n \"site\":null,\n \"project\":{\n \"id\": 1,\n \"number\": 1\n \"external_id\": \"PR000001\"\n },\n \"workflow\":{\n \"id\":\"1\",\n \"name\":\"Service\"\n },\n \"business_area\":null,\n \"business_division\":null,\n \"jobs\":[\n \n ],\n \"sub_total\":\"300\",\n \"tax_amount\":\"30\",\n \"total\":\"330\",\n \"sections\":[\n {\n \"description\":\"\",\n \"allotted_budget\":\"0\",\n \"line_items\":[\n {\n \"sales_price\":\"200\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"Standard Keyboard\",\n \"item_code\":{\n \"id\":\"10\",\n \"external_id\":\"ITM0000001\",\n \"name\":\"ITM0000001\"\n },\n \"location\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"type\":\"warehouse\",\n \"name\":\"Warehouse\"\n },\n \"job\":null\n },\n {\n \"sales_price\":\"100\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"\",\n \"item_code\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"name\":\"Electrical Labour\"\n },\n \"location\":null,\n \"job\":null\n }\n ]\n }\n ],\n \"recipient\":{\n \"id\": 10,\n \"type\": \"site\",\n \"name\": \"John Smith\"\n },\n \"status\":\"draft\",\n \"date\":\"2024-01-19\",\n}"}],"_postman_id":"5abe1dd9-508f-41ae-8098-a5fd57202553"},{"name":"Get Report list","id":"de31a377-62b6-43d3-b5f4-b67e2b8b83cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN"}],"url":"https://app.fieldinsight.com/public-api/reports/?update_from=2024-01-01T00:00:00&update_to=2024-01-01T23:59:59&external_id=000001&job_visit=111","description":"Returns fields describing the Invoice.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"Only include documents that were updated last time on or after this time in UTC timezone.
\n","type":"text/plain"},"key":"update_from","value":"2024-01-01T00:00:00"},{"description":{"content":"Only include documents that were updated last time before this time in UTC timezone.
\n","type":"text/plain"},"key":"update_to","value":"2024-01-01T23:59:59"},{"description":{"content":"Only include documents with this exiternal_id.
\n","type":"text/plain"},"key":"external_id","value":"000001"},{"description":{"content":"Only include documents that are associated with the specified job visit.
\n","type":"text/plain"},"key":"job_visit","value":"111"}],"variable":[]}},"response":[{"id":"9d9d6f8d-492c-41fc-8e88-27b2b32f1abe","name":"Get Reports","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer Ym9zY236Ym9zY28="}],"url":"https://app.fieldinsight.com/public-api/reports/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"id\":\"11\",\n \"printable_number\":\"REP-0001\",\n \"title\":\"Report 1\",\n \"created_at\":\"2024-01-19T20:38:03+1100\",\n \"updated_at\":\"2024-03-20T18:54:25+1100\",\n \"site\":null,\n \"project\":{\n \"id\": 1,\n \"number\": 1,\n \"external_id\": \"PR000001\"\n },\n \"workflow\":{\n \"id\":\"1\",\n \"name\":\"Service\"\n },\n \"business_area\":null,\n \"business_division\":null,\n \"jobs\":[\n \n ],\n \"sub_total\":\"300\",\n \"tax_amount\":\"30\",\n \"total\":\"330\",\n \"sections\":[\n {\n \"description\":\"\",\n \"allotted_budget\":\"0\",\n \"line_items\":[\n {\n \"sales_price\":\"200\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"Standard Keyboard\",\n \"item_code\":{\n \"id\":\"10\",\n \"external_id\":\"ITM0000001\",\n \"name\":\"ITM0000001\"\n },\n \"location\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"type\":\"warehouse\",\n \"name\":\"Warehouse\"\n },\n \"job\":null\n },\n {\n \"sales_price\":\"100\",\n \"qty\":\"1\",\n \"discount\":\"0\",\n \"description\":\"\",\n \"item_code\":{\n \"id\":\"1\",\n \"external_id\":\"\",\n \"name\":\"Electrical Labour\"\n },\n \"location\":null,\n \"job\":null\n }\n ]\n }\n ],\n \"recipient\":{\n \"id\": 10,\n \"type\": \"site\",\n \"name\": \"John Smith\"\n },\n \"status\":\"draft\",\n \"date\":\"2024-01-19\",\n }\n]"}],"_postman_id":"de31a377-62b6-43d3-b5f4-b67e2b8b83cd"},{"name":"Get Report PDF","id":"3546d5c7-b26f-4704-9efe-db47b606cfb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ACCESS_TOKEN","type":"text"}],"url":"https://app.fieldinsight.com/public-api/reports/:report_id/pdf/","description":"This endpoint generates a PDF document. It returns a response with status 302 and a url of the generated file in the Location header.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"headerPrefix","value":"Bearer"},{"key":"useBrowser","value":"