Katapult Pro V2 Documentation

🚀 A newer API is available — use Katapult Pro API v3

v3 is the actively developed, recommended API for all new integrations. v2 remains supported as a legacy version but is no longer receiving new features. Compared with v2, v3 adds:

A token-bucket rate limit with published per-call costs and a token balance (meta) on every response — instead of v2's fixed throttle — so you can budget and pace your requests. See Rate limits & the token bucket.

Consistent success/error envelopes (status / data / meta, with typed error types) that are easier and more reliable to parse.

Granular per-entity REST endpoints for nodes, connections, sections, and photos — create, update, and delete individual items without rewriting whole jobs.

New resources not available in v2: photo elements, calibration anchors, traces, models, and users.

A machine-readable OpenAPI 3.1 spec, plus Node and Python examples and a Postman collection.

New to the API? Start with v3. The rest of this page documents the legacy v2 API.

API Key Generation

The Katapult Pro API key is available for users to generate locally. To generate your own user authenticated API Key, you must have permissions setup to do so by your company Admin. Your company Admin should visit the Admin page in Katapult Pro, click on your user, click "Roles," and grant you API Access.

Once your admin has done so, the user granted API Access should navigate to their Home page in Katapult Pro by either entering the url https://katapultpro.com/home or selecting the App Tray menu and selecting Home. If you're Home page is empty, and you see a message that states "It's feeling lonely,” open the widget library by clicking the "Edit Widgets" button in the top right corner and select the Api Widget from the tray by clicking the blue "+" in the corner of the widget card.

If the API Key area appears blank, then it is the first time that a key is to be generated. If the Generate Key button is pushed, a key will be generated for you. After generating your key, you can either select “Copy Key” or highlight the key data and then paste into your application. For security reasons, there is a 10 second timeout on viewing your key. Once it expires, you will see a button saying “View API Key.” Click this button to view your key again for another 10 seconds. If your key has been compromised, you can regenerate a new one at any time.

Generation Dialog:

Timeout Dialog:

Rate limit

The Katapult Pro API V2 incorporates a throttling mechanism which limits the user’s back-to-back calls to the API. Currently, the default timeout has been set to two seconds. What this means is that after the first call to the API, the user must wait two seconds before executing the next call. Currently, the time base for this setting is in seconds with a low end to be equal to one.

Baseline Url

If running on a private server, include the sub-domain of your private server before katapultpro.com.

Ex: If your URL for accessing Katapult Pro on your private server were company.katapultpro.com, then instead of katapultpro.com/api/v2/jobs you'd use company.katapultpro.com/api/v2/jobs

GET Welcome Message

Message: katapultpro.com/api/v2?api_key={{api-key}}

Average token cost: 1

Welcome to the Katapult Pro API

This simple API GET request is provided to allow the user to test basic API access. This request can be used to test your basic starter application to ensure the subscription is active and your "Welcome Message" API request is working before moving on to more complex requests.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` in the example message above with your API key (no curly braces)	Yes

Example GET Welcome Message Request:

var axios = require('axios');
var data = '';

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Welcome Message Response:

{
    "message": "Welcome to the Katapult Pro API V2"
}

GET User List

Message: katapultpro.com/api/v2/users?api_key={{api-key}}

Average token cost: 39

This GET request will return all of the users within your company.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Example GET User List Request:

var axios = require('axios');

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/users?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET User List Response:

{
    "rqtVnITNGsOZg1NPq1yv1tnICoX2": {
        "address": {
            "city": "",
            "state": "",
            "street_line_1": "",
            "street_line_2": "",
            "zip": ""
        },
        "api_access": true,
        "creation_date": 1672929589000,
        "email": "jsmith@company.com",
        "last_active": 1694791391367,
        "name": {
            "first": "John",
            "last": "Smith"
        },
        "phone_number": "",
        "read_permission": true,
        "roles": {
            "photoheight": {
                "company": "Company",
                "company_admin": true,
                "permissions": {
                    "model_editor_read_access": true,
                    "model_editor_write_access": true
                }
            }
        },
        "write_permission": true
    }
}

GET Job List

Message: katapultpro.com/api/v2/jobs?orderByChild={{status || name}}&equalTo={{archived || active || job_name}}&{{metadata_attribute_name}}={{metadata_value_for_filtering}}&api_key={{api-key}}

Average token cost: 1115

This GET request will return a list of all jobs for your company.

The orderByChild and equalTo query parameters can be used to filter the job list to only jobs that have a certain status or name.

For example, by setting orderByChild to "status" and equalTo to "active," a list of all jobs that aren't archived are returned. Another example is setting orderByChild to "name" and equalTo to "Test Job". In this case, the job with the name "Test Job" is returned.

Query Params

Parameter	Value	Description	Required?
orderByChild	Set to "status" or "name"	Select one of these two sorting methods. Order/sort jobs by Job Status or Job Name	No
equalTo	Set to "archived," "active," or the name of the job in place of `job_name`	If "status" is used for `orderByChild`, use "archived" or "active;" if "name" is used for `orderByChild`, use the job name to return items that have matching values	No
filter	`{{metadata_attribute_name}}`	Replace `{{metadata_attribute_name}}` with the name of the metadata attribute you want (in snake case) to filter the list with	No
value	`{{metadata_value_for_filtering}}`	Replace `{{metadata_value_for_filtering}}` with the value of the filter attribute that the filtered jobs should have	No
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Example GET Job List Request:

var axios = require('axios');
var data = '';

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs?orderByChild=name&equalTo=Test Job&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc7096789b515c2a03e4abc2174e-89Ee5cd5d4a656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c91d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54decaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a61e8d1-b01a53b44a389643f408b93333d79afbb4a-f1e944ab98312ce836a1a3a3',
  headers: { },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Job List Response:

{
    "-Lmz77ZC6bIjCMToOBXy": {
        "name": "Test Job",
        "status": "active"
    }
}

GET Updated Jobs List

Message: katapultpro.com/api/v2/updatedjobslist?fromDate={{fromDate}}&toDate={{toDate}}&useToday={{true || false}}&api_key={{api-key}}

Average token cost: 1

This GET request uses a specified timeframe (the to and from dates) to return an object containing a list of Job IDs and their timestamps of when they were last updated. Jobs in this list are jobs that have been updated between the start and end dates. This request only includes jobs that are owned by your company, not jobs that are owned by another company and shared with you.

**** Important Note **** It is important that the length of the array that is returned from this request is monitored by your calling code routine. If the size of the array is 200, (which is the limit of the query,) then the user should expect that there are more than 200 total updated jobs in the query. If this is the case, you can simply use the last last_updated value in the array as the next {{fromDate}} to get the next set of jobs within your time frame. Please continue this method repeatedly until the length of the result is less than 200. We do not return the entire list of jobs within the queried time period initially.

Query Params

Parameter	Value	Description	Required?
fromDate	`{{fromDate}}`	Replace `{{fromDate}}` with the starting date. You can use any format accepted by a JS Date Object. This value is exclusive (results will start after this date).	Yes
toDate	`{{toDate}}`	Replace `{{toDate}}` with the ending date. You can use any format accepted by a JS Date Object. This value is exclusive (results will end before this date).	Yes
useToday	Set to "true" or "false"	If marked true, the timestamp for the moment your request is received will be used for the end of the timeframe (for `toDate`)	No
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Example GET Updated Jobs List Request:

var axios = require('axios');
var data = '';

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/updatedjobslist?fromDate=11/28/23&useToday=true&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Updated Job List Response:

[  
    {  
        "jobId": "-N_4KXQ5CpSO9Tnmy6vX",  
        "last_updated": "2023-07-28T14:35:02.259Z"  
    },  
    {  
        "jobId": "-NaNYiarOSF8_laR297a",  
        "last_updated": "2023-07-27T18:47:08.482Z"  
    },  
    {  
        "jobId": "-NaNGnTKmclbtlmmq84u",  
        "last_updated": "2023-07-27T18:25:13.038Z"  
    }  
]

GET Updated Nodes List

Message: katapultpro.com/api/v2/updatednodeslist?fromDate={{fromDate}}&toDate={{toDate}}&useToday={{true || false}}&jobId={{jobId}}&attribute={{attribute_name}}&changed={{true || false}}&api_key={{api-key}}

Average token cost: 23

This GET request uses a specified timeframe (to and from dates) and a Job ID to get a list of nodes whose specified attribute has been changed in that job during that timeframe. The GET returns an object with each node listed, including the Node ID and the timestamp for when the node's specified attribute changed.

**** Important Note **** It is important that the length of the array that is returned from this request is monitored by your calling code routine. If the size of the array is 200, (which is the limit of the query,) then the user should expect that there are more than 200 total updated nodes in the query. If this is the case, you can simply use the last date in the array as the next {{fromDate}} to get the remaining Updated Nodes List. Please continue this method repeatedly until there is a zero length array received. We do not return the entire length of the queried time period initially entered.

Query Params

Parameter	Value	Description	Required?
fromDate	`{{fromDate}}`	Replace `{{fromDate}}` with the starting date in the MM/DD/YY format (without leading zeros) i.e. 11/28/23	Yes
toDate	`{{toDate}}`	Replace `{{toDate}}` with the ending date in the MM/DD/YY format (without leading zeros) i.e. 2/1/23	Yes
useToday	Set to "true" or "false"	If marked true, the timestamp for the moment your request is received will be used for the end of the timeframe (for `toDate`)	No
jobId	`{{jobId}}`	Replace `{{jobId}}` with the valid Job ID	Yes
attribute	`{{attribute_name}}`	Filter nodes by whether or not the specified attribute (replace `{{attribute_name}}` with the name of the attribute in snake case) has been changed in the given timeframe (optional)	No
changed	Set to "true" or "false"	List the nodes that were changed (using "true") or the nodes that were NOT changed (using "false")	No
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Example GET Updated Nodes List Request:

var axios = require('axios');
var data = '';

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/updatednodeslist?fromDate=11/28/23&useToday=true&jobId=-OKRkT1ZRf9rSiF8qiwL&attribute=field_completed&changed=true&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Updated Nodes List Response (with changed=true):

[  
    {  
        "nodeId": "-OKRkji6P2b5OJc57Rxr",  
        "set_as": "2023-07-28T14:35:02.259Z"  
    },  
    {  
        "nodeId": "-OKRkjvqRyBQxDa8OoGb",  
        "set_as": "2023-07-27T18:47:08.482Z"  
    },  
    {  
        "nodeId": "-NaNGnTKmclbtlmmq84u",  
        "set_as": "2023-07-27T18:25:13.038Z"  
    }  
]

GET Updated Nodes List Response (if it were changed=false):

[  
    {  
        "nodeId": "-OKRkYt3rlTXv7Zl5tT-"
    },  
    {  
        "nodeId": "-OKRkZ2M_tsGuILuSOYR"
    },  
    {  
        "nodeId": "-OKRkZFYIO3L8x7rftql"
    }  
]

GET Attribute Tracking List

Message: katapultpro.com/api/v2/attributeTracking/:jobId?api_key={{api-key}}

Average token cost: 1

This GET request will return the latest attribute tracking data for that job. (Make sure to replace the path variable :jobId with the job's valid Job ID.)

**** Important Note **** It is important that the amount of items that is returned from this request is monitored by your calling code routine. If there are more than 200 items stored in the attribute_changes key, (which is the limit of the query,) then the user should expect that there are more than 200 total attribute changes in the query. If this is the case, you can simply use the last date in the list as the next {{fromDate}} to get the remaining Attribute Tracking List. Please continue this method repeatedly until there is a zero length list received. We do not return the entire length of the queried time period initially entered.

Query Params

Parameter	Value	Description	Required?
fromDate	`{{fromDate}}`	Replace `{{fromDate}}` with the starting date in the MM/DD/YY format (without leading zeros) i.e. 11/28/23	Yes
toDate	`{{toDate}}`	Replace `{{toDate}}` with the ending date in the MM/DD/YY format (without leading zeros) i.e. 2/1/23	Yes
useToday	Set to "true" or "false"	If marked true, the timestamp for the moment your request is received will be used for the end of the timeframe (for `toDate`)	No
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id found

Example GET Attribute Tracking List Request:

var axios = require('axios');
var data = '';

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://katapultpro.com/api/v2/attributeTracking/-NbLE2N_uhApTcVotF4X?fromDate=11/28/23&toDate=12/23/24&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Attribute Tracking List Response:

{
   "jobId": "-NbLE2N_uhApTcVotF4X",
    "jobName": "Testing attribute tracking",
    "attribute_changes": {
        "c7f6843dbcacaea36d847f901e6bea8f": {
            "timestamp": 1692199883822,
            "entity_type": "NODE",
            "entity_id": "-NbyyGEGYG3wPe6AABRu",
            "attribute": "internal_note",
            "value_key": "button_added",
            "value": "",
            "user": "TaSs4PIIboZ9labZxm6RmeCREmm1"
        },
        "befed3a7581374486d847f901e6bea8f": {
            "timestamp": 1692199883822,
            "entity_type": "NODE",
            "entity_id": "-NbyyGEGYG3wPe6AABRu",
            "attribute": "done",
            "value_key": "button_added",
            "value": false,
            "user": "TaSs4PIIboZ9labZxm6RmeCREmm1"
        },
        "40ab4528fd1d44d56d847f901e6bea8f": {
            "timestamp": 1692199883822,
            "entity_type": "NODE",
            "entity_id": "-NbyyGEGYG3wPe6AABRu",
            "attribute": "node_type",
            "value_key": "button_added",
            "value": "pole",
            "user": "TaSs4PIIboZ9labZxm6RmeCREmm1"
        }
    }
}

GET Job Data

Message: katapultpro.com/api/v2/jobs/:jobId?api_key={{api-key}}

Average token cost: 1757

This GET request will return the data for the job specified. (Make sure to replace :jobId with the job's valid Job ID.) Currently, the layer data has been omitted from the JSON data returned in the API response. The layer data can be too large for the response body.

Visit this link to see the structure for job data: https://katapultpro.com/schema/job.json. The data received in the API response body will contain all or some of the data as outlined in the link. This will be dependent on that data contained in each node, connection, etc. in the job (matching the provided Job ID) requested.

You can optionally include the include_proposed_midspan_heights query parameter with a value of “true” to include calculated proposed heights for midspan wire objects in the output.

The _api_proposed_height key will be added to wire objects in midspans for either of these cases:

The midspan wire is proposed
The midspan wire is moved - either by a Make Ready move on the wire in the midspan itself or by a move on a pole at either end of the connection the midspan is on.

The value for _api_proposed_height is the calculated proposed height for the midspan wire in inches.

You can optionally include the include_company_picklist query parameter as well with a value of "true" to show the companies in their respective picklists under the Company attribute for the job model used in the job.

Query Params

Parameter	Value	Description	Required?
include_proposed_midspan_heights	Set to "true"	Include proposed midspan heights in the response body	No
include_proposed_existing_and_markers	Set to "true"	Include this if proposed and existing heights are needed for all markers; you will see the proposed heights, existing heights, and marker IDs in the response body	No
height_marker_type	Set to "node," "midspan," or "both"	Optional parameter when using `include_proposed_existing_and_markers` to set which height photos should include the height data	No
include_pixel_selection	Set to "true"	Include this parameter and set it to "true" if pixel selection coordinates are needed for all markers	No
include_anchor_calibrations	Set to "true"	Include this parameter if anchor calibration markers should be included in the response body	No
include_mr_directives	Set to "true"	The response body will include Make Ready Directives for nodes and sections if this parameter is set to "true"	No
include_company_picklist	Set to "true"	The response body will include the picklist values for the Company attribute for the job model used for the job you are accessing at the end of the body	No
api_key	`{{api-key}}`	Replace `{{api-key}}` with you API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id

Example GET Job Data Requst (Basic Request):

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-N9lrzHqQm7pvCJoj5w6?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

GET Job Data Response:

{
    "connections": {
        "-NSGzkSLuepnLrHBMDsy": {
            "_created": {
                "method": "desktop",
                "timestamp": 1680707880790,
                "uid": "cPKA4ptkD1PplRH1Rs2MrjVHE8f1"
            },
            "attributes": {
                "connection_type": {
                    "button_added": "aerial cable"
                }
            },
            "button": "aerial",
            "node_id_1": "-NSGzkSK3-7ce4VJo9fX",
            "node_id_2": "-NSGzjoK3bNio0SZWe2C"
        },
        "-NSGzkunNqlwTQndVnVF": {
            "_created": {
                "method": "desktop",
                "timestamp": 1680707882675,
                "uid": "cPKA4ptkD1PplRH1Rs2MrjVHE8f1"
            },
            "attributes": {
                "connection_type": {
                    "button_added": "aerial cable"
                }
            },
            "button": "aerial",
            "node_id_1": "-NSGzkumOX1FHynLR9RG",
            "node_id_2": "-NSGzkSK3-7ce4VJo9fX"
        },

        ........ Rest of Data Omitted Due to Length *********

    }
}

Same GET Job Data Response (but with include_proposed_existing_and_markers=true in request):

{

    ........ Beginning Data Omitted Due to Length *********

    "nodes": {
            "-M2YUhu9X9vNaY5wFU3T": {

                ........ Additional Data Omitted Due to Length *********

                "_proposed_existing_and_label_data": [
                    {
                        "existing_height": 457.31,
                        "proposed_height": 457.31,
                        "marker_label": "Pole Top"
                    },
                    {
                        "existing_height": 448.91,
                        "proposed_height": 448.91,
                        "marker_label": "MET-ED Primary"
                    },
                    {
                        "existing_height": 412.02,
                        "proposed_height": 412.02,
                        "marker_label": "MET-ED Cutout Arrestor"
                    },
                    {
                        "existing_height": 387.58,
                        "proposed_height": 387.58,
                        "marker_label": "MET-ED Termination Bracket"
                    },

                    ........ Rest of Data Omitted Due to Length *********
                ]
            }
    }
}

Same GET Job Data Response (but with include_pixel_selection=true and include_anchor_calibrations=true in request):

{

    ........ Beginning Data Omitted Due to Length *********

    "nodes": {
            "-M2YUhu9X9vNaY5wFU3T": {
                "_proposed_existing_and_label_data": [

                ........ Additional Data Omitted Due to Length *********

                    {
                        "existing_height": 252.53,
                        "proposed_height": 252.53,
                        "marker_label": "Comcast - Williamsport CATV Com",
                        "pixel_selection": [
                            {
                                "percentX": 47.65352323643377,
                                "percentY": 39.65934446031943
                            }
                        ]
                  },
                  {
                      "existing_height": 212.41,
                      "proposed_height": 212.41,
                      "marker_label": "CTSI, LLC, Dba Frontier Communications Telco Com",
                      "pixel_selection": [
                          {
                              "percentX": 50.391601764197546,
                              "percentY": 47.767067465788564
                          }
                      ]
                  },
                  {
                      "existing_height": 16.5,
                      "proposed_height": 16.5,
                      "marker_label": "Anchor Calibration",
                      "pixel_selection": [
                          {
                              "percentX": 49.85583863910207,
                              "percentY": 50.74869937852991
                          }
                      ]
                  },

                    ........ Rest of Data Omitted Due to Length *********
                ]
            }
    }
}

Same GET Job Data Response (but with the include_company_picklists=true in request):

{
    "connections": {
        "-NSGzkSLuepnLrHBMDsy": {
            "_created": {
                "method": "desktop",
                "timestamp": 1680707880790,
                "uid": "cPKA4ptkD1PplRH1Rs2MrjVHE8f1"
            },
            "attributes": {
                "connection_type": {
                    "button_added": "aerial cable"
                }
            },
            "button": "aerial",
            "node_id_1": "-NSGzkSK3-7ce4VJo9fX",
            "node_id_2": "-NSGzjoK3bNio0SZWe2C"
        },
        ........ Additional Data Omitted Due to Length *********
    },
    "companyPicklists": {
        "other_companies": [
            {
                "value": "CATV"
            },
            {
                "value": "Fiber"
            },
            {
                "value": "Telco"
            },
            {
                "value": "Unknown"
            }
        ],
        "power_companies": [
            {
                "value": "Power Co"
            }
        ]
    }
}

GET Partial Job Data

Message: katapultpro.com/api/v2/jobs/:jobId/:paths?api_key={{api-key}}

Average token cost: 115

Average token cost by common path:

Path	Average token cost
nodes	184
photos	1360
nodes/:nodeId	1
photos/:photoId	1

This GET request returns the data at the specified paths for that job. You can include one path or up to 10 paths, separated by commas. Each path can have multiple path components, each separated with a forward slash.

For example, to fetch all nodes in a job, your path after the Job ID should be "nodes". To fetch data for a specific node, your path should be "nodes/{{node_id}}" where {{node_id}} is the valid ID of the node of interest. To fetch data for a specific node and the job name, your path list should be "node/{{node_id}},name".

If you only include one path, only the data at that path will be returned. If you include multiple paths, a JSON object will be returned. The keys of the returned object will be the paths you requested, regardless of whether there is data in the job at those paths or not. The values for those keys will be the data at those paths. If there is no data at a path requested, the value will be null.

Visit this link to see the structure for job data: https://katapultpro.com/schema/job.json

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:paths	A comma separated list of paths that should be fetched from the job

Example GET Partial Job Data Request (For Node Data in Job):

var axios = require('axios');

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-N9lrzHqQm7pvCJoj5w6/nodes?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Partial Job Data (For Node Data in Job) Response:

{
  "nodes": {
    "-M2YUhu9X9vNaY5wFU3T": {
      "attributes": {
        "address": {
          "button_added": "20 Old York Rd, Dillsburg, PA 17019, USA"
        },
        "done": {
          "-M2YpKGiES_oIGV-vBPx": true
        },
        "field_completed": {
          "value": true
        },
        "google_elevation": {
          "button_added": "596 ft"
        },
        "measured_pole_height": {
          "one": "37.9"
        },
        "node_type": {
          "-M2YUoGiES_oIGV-vBPv": "pole"
        },
        "pole_class": {
          "one": "4"
        },
        "pole_height": {
          "one": "45"
        },
        "pole_spec": {
          "button_calced": "45-4 Douglas Fir"
        },
        "pole_species": {
          "one": "Southern Pine"
        },
        "pole_tag": {
          "multi_added": {
            "company": "Power Co",
            "owner": false,
            "tagtext": "20184 28261"
          }
        },
        "scid": {
          "auto_button": "004"
        },
        "time_bucket": {
          "-4IYb_xfJQs3RibCe2j": {
            "start": 1584366709987,
            "stop": 1584366772084,
            "uid": "f7a257cf-4a0a-51v3-8834-e54b85b77d7c"
          }
        },
        "vantage_point": {
          "auto_button": {
            "latitude": 40.10694889153705,
            "longitude": -77.0279890671048
          }
        }
      },
      "latitude": 40.10706582519959,
      "longitude": -77.02798504379128,
      "photos": {
        "03e35fde-c41d-4597-bc7b-b1f10273104f": {
          "association": true
        },
        "2696c773-05d2-4c7d-bd52-dad2281b808e": {
          "association": true
        },
        "4fcc29a8-50s0-43bd-95q0-5df791ecb071": {
          "association": true
        },
        "df0e7121-4d1a-0e65-9731-b82248c063be": {
          "association": "main"
        }
      }
    },
    "-M2GUhu5F9mYaY5wFUoP": {
                   ........ Rest of Data Omitted Due to Length *********
    }
  }                 
}

GET Photo URL

Message: katapultpro.com/api/v2/jobs/:jobId/photoURL/:photoId?file_size={{full || extra_large || large || small || tiny}}&file_type={{webp || jpg}}&api_key={{api-key}}

Average token cost: 2

This GET request will return a URL you can use to download the photo with a matching Photo ID contained on the server. This requires that a previous request to the job has been made to obtain the photo ID to be used. Anything other than a valid photo ID for that job will be rejected. You can specify the size of the photo to fetch. If you don't specify, the full size will be used. You can also specify the type of photo to fetch. If you don't specify, webp will be used.

Visit this link to see the structure for job data: https://katapultpro.com/schema/job.json

Query Params

Parameter	Value	Description	Required?
file_size	Set to "full", "extra_large", "large", "small" or "tiny" ("extra_large" is the size typically used when viewing photos in Katapult Pro)	The size of the photo to use when fetching the photo URL. An error will be returned if the photo does not have the specified size. If you don't include the `file_size` query parameter, the "full" size will be used.	No
file_type	Set to "webp" or "jpg"	The type of photo to fetch. An error will be returned if the photo does not have the specified type. If you dont include the `file_type` parameter, "webp" will be used.	No
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:photoId	A valid photo push ID within the selected job

Example GET Photo URL Request:

var axios = require('axios');

var config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-NgVTYY_sWEyFzpLHXWT/photoURL/015eb1ba-e8c9-4824-a721-904785q205vs?file_size=extra_large&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Photo URL Response:

{
    "url": "https://firebasestorage.googleapis.com/v0/b/katapult-production.appspot.com/o/photos%2F015eb1bdd-e8c9-4824-a721-9047aeafdee5_extra_large.webp?alt=media&token=6c8f5b2a-c578-4f4b-ba68-ff6674e96f40"
}

GET Pages

Message: katapultpro.com/api/v2/company-data/pages?&api_key={{api-key}}

Average token cost: TBD

This GET request will request the pages from the user's company. This allows the user to include the links to each of their company's pages, both standard and custom, in the nine-dot menu of their custom extensions.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Example GET Pages Request:

var axios = require("axios");

var config = {
  method: "get",
  maxBodyLength: Infinity,
  url: "katapultpro.com/api/v2/company-data/pages?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc7096789b515c2a03e4abc2174e-89Ee5cd5d4a656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c91d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54decaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a61e8d1-b01a53b44a389643f408b93333d79afbb4a-f1e944ab98312ce836a1a3a3",
  headers: {}
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

GET Pages Response:

[
    {
        "page": "pole-application-overview",
        "order": 1,
        "name": "app overview",
        "color": "var(--paper-grey-700)",
        "icon": "format_list_bulleted",
        "url": "pole-application-overview/",
        "isExtension": false
    },
    {
        "page": "admin",
        "order": 2,
        "name": "admin",
        "color": "var(--paper-red-600)",
        "icon": "group",
        "url": "admin/",
        "isExtension": false
    },
    {
        "page": "photos",
        "order": 2,
        "name": "photos",
        "color": "var(--paper-blue-500)",
        "icon": "image",
        "url": "photos/",
        "isExtension": false
    },
    {
        "page": "upload",
        "order": 3,
        "name": "upload",
        "color": "var(--paper-deep-purple-500)",
        "icon": "file_upload",
        "url": "upload/",
        "isExtension": false
    },
    {
        "page": "pole-application",
        "order": 3,
        "name": "app view",
        "color": "var(--paper-light-blue-500)",
        "icon": "assignment",
        "url": "pole-application/",
        "isExtension": false
    },
    {
        "page": "map",
        "order": 4,
        "name": "survey view",
        "color": "var(--paper-green-700)",
        "icon": "map",
        "url": "map/",
        "isExtension": false
    },
    {
        "page": "dashboard",
        "order": 4,
        "name": "dashboard",
        "color": "var(--paper-indigo-500)",
        "icon": "dashboard",
        "url": "dashboard/",
        "isExtension": false
    },
    {
        "page": "viewer",
        "order": 5,
        "name": "viewer",
        "color": "#E91E63",
        "icon": "photo_library",
        "url": "viewer/",
        "isExtension": false
    },
    {
        "page": "home",
        "order": 6,
        "name": "home",
        "color": "var(--paper-teal-600)",
        "icon": "home",
        "url": "home/",
        "isExtension": false
    },
    {
        "page": "search",
        "order": 7,
        "name": "search",
        "color": "var(--paper-brown-700)",
        "icon": "search",
        "url": "search/",
        "isExtension": false
    },
    {
        "page": "model-editor",
        "order": 8,
        "name": "model-editor",
        "color": "var(--paper-deep-orange-500)",
        "icon": "settings",
        "url": "model-editor/",
        "isExtension": false
    },
    {
        "page": "https://katapult-template-test.web.app/",
        "name": "API Template",
        "color": "#26DFD6",
        "icon": "amp_stories",
        "url": "https://katapult-template-test.web.app//",
        "isExtension": true
    },
    {
        "page": "https://github.com/KatapultDevelopment/katapult-pro-api-documentation/blob/main/README.md",
        "name": "API Reference",
        "color": "#2A26DF",
        "icon": "assistant",
        "url": "https://github.com/KatapultDevelopment/katapult-pro-api-documentation/blob/main/README.md/",
        "isExtension": true
    },
    {
        "page": "https://www.katapultengineering.com/blog/integrated-pole-loading",
        "name": "Pole Loading",
        "color": "#94094E",
        "icon": "library_books",
        "url": "https://www.katapultengineering.com/blog/integrated-pole-loading/",
        "isExtension": true
    },
    {
        "page": "pole-application-getting-started",
        "order": 5,
        "name": "getting started",
        "color": "var(--paper-indigo-500)",
        "icon": "help",
        "url": "pole-application-getting-started/",
        "isExtension": false
    },
    {
        "page": "project-management",
        "name": "project management",
        "color": "var(--primary-color)",
        "icon": "hub",
        "url": "project-management"
    }
]

POST Create Node

Message: katapultpro.com/api/v2/jobs/:jobId/nodes?api_key={{api-key}}

Average token cost: 197

This POST request creates a new node within a job. The job must be existing, and its Job ID needs to be passed along as a path variable. The payload body needs a latitude/longitude at a minimum, but it can take an array of objects, denoting attributes to include on the newly created node. Please note that the request can add a single node or multiple nodes. The body is setup for an array of objects. If a total of more than 100 nodes are passed in the body, the request will be rejected. If this occurs, you can repeat the request multiple times to complete a larger node count. An example body is shown after the query params and path variables.

Visit this link to see the structure for job data (inside which is the structure for node data): https://katapultpro.com/schema/job.json

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id

Example Payload Body

{
    "nodes":[
        {
            "latitude": 40.1054820,
            "longitude": -77.0231781,
            "attributes": [
                {"attribute": "node_type", "value": "pole"}
            ]
        },
        {
            "latitude": 40.1054289,
            "longitude": -77.0229224,
            "attributes": [
                {"attribute": "node_type", "value": "pole"}
            ]
        }
    ]
}

Example POST Create Node Request:

var axios = require('axios');
var data = JSON.stringify({
    "nodes":[
        {
            "latitude": 40.1054820,
            "longitude": -77.0231781,
            "attributes": [
                {"attribute": "node_type", "value": "pole"}
            ]
        },
        {
            "latitude": 40.1054289,
            "longitude": -77.0229224,
            "attributes": [
                {"attribute": "node_type", "value": "pole"}
            ]
        }
    ]
});

var config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-NEHqS0tfoLCECdgOAh-/nodes?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

POST Create Node Response:

Note: The return payload from this request will provide a list of push ID's for your newly created nodes. You can use this information to PATCH in any new attributes or add attributes and settings to the node.

{
    "jobId": "-N_9o3H3_PmKWs88JDfz",
    "NodesCreated": [
        {
            "key": "-NnKcywg4nOcroLJwIf-",
            "data": {
                "latitude": 40.105482,
                "longitude": -77.0231781,
                "_created": {
                    "uid": "unknown",
                    "timestamp": 1704391339820,
                    "method": "api"
                },
                "attributes": {
                    "node_type": {
                        "-NnKcywg4nOcroLJwIf0": "pole"
                    }
                }
            }
        },
        {
            "key": "-NnKcywngKFqiLEU5-Hs",
            "data": {
                "latitude": 40.1054289,
                "longitude": -77.0229224,
                "_created": {
                    "uid": "unknown",
                    "timestamp": 1704391339827,
                    "method": "api"
                },
                "attributes": {
                    "node_type": {
                        "-NnKcywngKFqiLEU5-Ht": "pole"
                    }
                }
            }
        }
    ]
}

POST Create Job

Message: katapultpro.com/api/v2/jobs?api_key={{api-key}}

Average token cost: 16

This POST request creates a new job. The payload body needs a job name, the map styles, and model name. Please note that the request can add a single job or multiple jobs. The body is setup for an array of objects. If a total of more than 100 jobs are passed in the body, the request will be rejected. If this occurs, you can repeat the request multiple times to complete a larger jobs count. An example body is shown after the query params.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Example Payload Body:

{
        "name" : "API Test",
        "mapStyles" : "default",
        "model" : "Katapult"
}

Example POST Create Job Request:

const axios = require('axios');


var data = JSON.stringify({
    "name" : "API Test",
    "mapStyles" : "default",
    "model" : "Katapult"
});
var config = {
    method: 'post',
    maxBodyLength: Infinity,
    url: 'katapultpro.com/api/v2/jobs?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
    headers: { 
          'Content-Type': 'application/json'
    },
    data : data
    };
axios(config)
    .then(function (response) {
    console.log(JSON.stringify(response.data));
    })
    .catch(function (error) {
    console.log(error);
    });

POST Create Job Response:

Note: The return payload from this request will provide the Job Id for the newly created job. You can use this information to PATCH in any new attributes or add attributes and settings to the job.

{
    "jobId": "-N_9o3H3_PmKWs88JDfz"
}

PATCH Update Node on Job

Message: katapultpro.com/api/v2/jobs/:jobId/nodes/:nodeid?api_key={{api-key}}

Average token cost: TBD

This PATCH request updates an existing node within a job. The request requires a vaild Job ID and Node ID. The payload body can have a latitude/longitude and an array of objects, denoting which attributes to update.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:nodeId	The valid Node Id of the node to update

Example Payload Body:

{
    "latitude": 29.56486371782001,
    "longitude": -98.6970369527974,
    "attributes": [
        {
            "attribute": "company", 
            "value": "Unknown"
        }
    ]
}

Example PATCH Update Node on Job Request:

var axios = require('axios');
var data = JSON.stringify({
  "latitude": 29.56486371782001,
  "longitude": "-98.6970369527974",
  "attributes": [
    {
      "attribute": "node_type",
      "value": "pole"
    }
  ]
});


var config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-NEHqS0tfoLCECdgOAh-/nodes/-NEa1Q0IXKB2N5x_UZvL?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

PATCH Update Node on Job Response: Note: The return payload from this request will provide a confirmation and JSON of the changes.

{
    "key": "-NEa1Q0IXKB2N5x_UZvL",
    "data": {
        "_created": {
            "method": "api",
            "timestamp": 1704310046430,
            "uid": "unknown"
        },
        "attributes": {
            "node_type": {
                "-NnFqXoaZc8J5mOKQlkG": "pole"
            },
            "company": {
                "-NnFr9Kpe5QFQi7oBGmk": "Unknown"
            }
        },
        "latitude": 40.105482,
        "longitude": -77.0231781
    }
}

PUT Upload Photo To Node

Message: katapultpro.com/api/v2/jobs/:jobId/nodes/:nodeid/photos?api_key={{api-key}}

Average token cost: 2

This PUT request uploads a photo to a specific node. The request requires a vaild Job ID and Node ID. The payload body should be the image that will be added to the node.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:nodeId	The valid Node Id of the node to update

Example Payload Body:

var data = 'image.jpg'

Example PUT Upload Photo To Node Request:

var config = {
        method: 'put',
        maxBodyLength: Infinity,
        url: `${URL_PATH}${JOB_ID}/nodes${NODE_ID}/photos?api_key=${API_KEY}`,
        headers: { 
          'Content-Type': 'image/jpeg'
        },
        data : data
      };
    axios(config)
      .then(function (response) {
        console.log(JSON.stringify(response.data));
      })
      .catch(function (error) {
        console.log(error);
      });

PUT Upload Photo To Node Response: Note: The return payload from this request will provide a confirmation of the changes along with the PhotoID stored in a key.

{
    "message": "OK",
    "key": "d1757261-5z5w-41e8-802d-5a68a51a1427"
}

PUT Upload Photo To Section

Message: katapultpro.com/api/v2/jobs/:jobId/connections/:connectionId/sections/:sectionId/photos?api_key={{api-key}}

Average token cost: 2

This PUT request uploads a photo on a specific section. The request requires a vaild Job ID, Connection ID, and Section ID. The payload body should be the image that will be added to the node.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:nodeId	The valid Node Id of the node to update
:connectionId	The valid Connection Id of the connection to update
:sectionId	The valid Section Id of the section to update

Example Payload Body

var data = 'image.jpg'

Example PUT Upload Photo To Section

var config = {
        method: 'put',
        maxBodyLength: Infinity,
        url: 'katapultpro.com/api/v2/jobs/-OKRkT1ZRf9rSiF8qiwL/connections/-OKRkZFYIO3L8x7rftqm/sections/midpoint_section/photos?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
        headers: { 
          'Content-Type': 'image/jpeg'
        },
        data : data
      };
      console.log(config.url);
    axios(config)
      .then(function (response) {
        console.log(JSON.stringify(response.data));
      })
      .catch(function (error) {
        console.log(error);
      });
}

Response PUT Upload Photo To Section Note: The return payload from this request will provide a confirmation of the changes along with the PhotoID stored in a key.

{
    "message": "OK",
    "key": "4720d250-ebef-45d4-bb07-d64420e34435"
}

POST Upload Photo Data

Message: katapultpro.com/api/v2/jobs/:jobId/photos/:photoId?api_key={{api-key}}&marker_type={{marker_type}}

Average token cost: 93

This POST request will create markers (whether height annotations or photo chips) on the photo with the corresponding photo ID.

The payload body can be an array of markers to create or just a single object for one marker. The "marker_type" property is required as a query parameter as well as in the object for each marker. The "marker_type" query parameter will be used for every marker created.

Photo chip elements must not have a "pixel_selection" or "manual_height" property. Height annotation elements must have a "pixel_selection" property. The value for "percentX" and "percentY" in "pixel_selection" is a number between 0 and 100. For "percentX", 0 corresponds to the left edge of the photo, whereas 100 corresponds to the right edge of the photo. With "percentY", 0 corresponds to the top of the photo, while 100 corresponds to the bottom of the photo. The manual_height property should only be used for height annotations on a non-calibrated photo.

Any additional properties in the marker's object will be considered a marker attribute and applied to the marker.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes
marker_type	`{{marker_type}}`	The marker's input model (can be found in Model Editor under Photo Elements)	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:photoID	A valid photo push ID within the selected job

Example Photo Chip Payload Body

{
  "marker_type": "back"
}

Example Height Annotation Payload Body

{
  "marker_type": "wire",
  "pixel_selection": [{"percentX": 53.9373022720737, "percentY": 27.648835202761}]
}

Example POST Upload Photo Data Request:

var axios = require('axios');
var data = JSON.stringify({
  "marker_type": "wire",
  "pixel_selection": [{"percentX": 53.9373022720737, "percentY": 27.648835202761}]
});

var config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-NEHqS0tfoLCECdgOAh-/photos/4720d250-ebef-45d4-bb07-d64420e34435?marker_type=wire&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

POST Upload Photo Data Response:

{
  "message": "OK'
}

PATCH Replace Photo Data

Message: katapultpro.com/api/v2/jobs/:jobId/photos/:photoId?api_key={{api-key}}&marker_type={{marker_type}}&marker_key={{marker_key}}

Average token cost: TBD

This PATCH request will update the photo marker on the photo with the corresponding photo ID.

In the payload body, identify the marker you want to update by including its "marker_type" and "marker_key" in the object for the marker. These properties are also required as query parameters.

If you are updating a photo chip element, you must not include a "pixel_selection" or "manual_height" property in the marker object.

The value for "percentX" and "percentY" in "pixel_selection" is a number between 0 and 100. For "percentX", 0 corresponds to the left edge of the photo, whereas 100 corresponds to the right edge of the photo. With "percentY", 0 corresponds to the top of the photo, while 100 corresponds to the bottom of the photo. The manual_height property should only be used for height annotations on a non-calibrated photo.

Any other properties you include in the marker object will overwrite any existing marker data.

If you want to delete an existing marker, use the Delete Photo Data call.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes
marker_type	`{{marker_type}}`	The marker's input model (can be found in Model Editor under Photo Elements)	Yes
marker_key	`{{marker_key}}`	The key of the marker to update	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:photoID	A valid photo push ID within the selected job

Example Payload Body

{
  "marker_type": "wire",
  "marker_key": "-M2coEssj_C2cVRKilDl",
  "manual_height": "17-7",
  "pixel_selection": [{"percentX": 53.9373022720737, "percentY": 27.648835202761}]
}

Example PATCH Replace Photo Data Request:

var axios = require('axios');
var data = JSON.stringify({
  "marker_type": "wire",
  "marker_key": "-M2coEssj_C2cVRKilDl",
  "manual_height": "17-7",
  "pixel_selection": [{"percentX": 53.9373022720737, "percentY": 27.648835202761}]
});

var config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-NEHqS0tfoLCECdgOAh-/photos/4720d250-ebef-45d4-bb07-d64420e34435?marker_type=wire&marker_key=-M2coEssj_C2cVRKilDl&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

PATCH Replace Photo Data Response:

{
    "message": "OK"
}

DELETE Delete Photo Data

Message: katapultpro.com/api/v2/jobs/:jobId/photos/:photoId?api_key={{api-key}}&marker_type={{marker_type}}&marker_key={{marker_key}}

Average token cost: TBD

This DELETE request will remove the photo marker with the corresponding photo ID from the photo.

You do not need to provide a payload body for this call. Only the "marker_type" and "marker_key" properties are required as query parameters.

This call will return to you the key of the marker deleted as well as the marker data that was deleted.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes
marker_type	`{{marker_type}}`	The marker's input model (can be found in Model Editor under Photo Elements)	Yes
marker_key	`{{marker_key}}`	The key of the marker to delete	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id
:photoID	A valid photo push ID within the selected job

Example DELETE Photo Data Request:

var axios = require('axios');

var config = {
  method: 'delete',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-NEHqS0tfoLCECdgOAh-/photos/4720d250-ebef-45d4-bb07-d64420e34435?marker_type=wire&marker_key=-M2coEssj_C2cVRKilDl&api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : {}
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

DELETE Photo Data Response:

{
    "key": "-M2coEssj_C2cVRKilDl",
    "data": {
        "_manual_height": 303,
        "manual_height": "25-3",
        "pixel_selection": [
            {
                "percentX": 53.9373022720737,
                "percentY": 27.648835202761
            }
        ]
    }
}

PUT Archive a Job

Message: katapultpro.com/api/v2/jobs/:jobId/archive?api_key={{api-key}}

Average token cost: 1

This PUT request will change the specified job's status from 'active' to 'archived.' The job ID is required to complete this request.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id

Example PUT Archive a Job

var axios = require('axios');

var config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/-N_9o3H3_PmKWs88JDfz/archive?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

PUT Archive a Job To Section Response

{
    "message": "Job status set to archived"
}

PUT Un-Archive a Job

Message: katapultpro.com/api/v2/jobs/:jobId/unarchive?api_key={{api-key}}

Average token cost: TBD

This PUT request will change the job's status from 'archived' to 'active.' The job ID is required to complete this request.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:jobId	The valid Job Id found

Example PUT Un-Archive a Job

var axios = require('axios');

var config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: 'katapultpro.com/api/v2/jobs/:jobId/unarchive?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
  headers: { }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Response PUT Un-Archive a Job

{
    "message": "Job status set to active"
}

GET App Buttons

Message: workflow-management.katapultpro.com/api/v2/application/getAllowedActionButtons/:appId?api_key={{api-key}}

Average token cost: TBD

This GET request will return all the buttons that would appear on the application (that matches the provided App ID) given its status at the time of the request. The response is a list containing the ID and Name of each button on the application.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:appId	The valid Id of the application you are accessing

Example GET App Buttons Request:

    var axios = require(‘axios’);
    var config = {
        method: 'get',
        maxBodyLength: Infinity,
        url: 'workflow-management.katapultpro.com/api/v2/application/getAllowedActionButtons/-OwmIsbn3idk2IkOksLs?a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
        headers: { 
          'Content-Type': ‘application/json'
        },
        data : data
    };

    axios(config)
      .then(function (response) {
        console.log(JSON.stringify(response.data));
      })
      .catch(function (error) {
        console.log(error);
      });
}

GET App Buttons Response:

[
    {
        “-OxkdEj8sIfKxMe3WO0a”: “Estimate Complete”
    }
]

GET App Prompts

Message: workflow-management.katapultpro.com/api/v2/application/getAppPrompts/:appId?button_id={{button-id}}&api_key={{api-key}}

Average token cost: TBD

This GET App Prompts request will return the prompt that the button (matching the provided button ID) triggers. For the ‘button_id’ query parameter, use the ID of the desired button from the response to the GET App Buttons request.

Query Params

Parameter	Value	Description	Required?
button_id	`{{button-id}}`	Replace `{{button-id}}` with the ID of the button that triggers the app’s prompts	Yes
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:appId	The valid Id for the application you are accessing

Example GET App Prompts Request:

var axios = require(‘axios’);
var config = {
        method: 'get',
        maxBodyLength: Infinity,
        url: 'workflow-management.katapultpro.com/api/v2/application/getAppPrompts/-OwmIsbn3idk2IkOksLs?api_key=a234a28d_C6745ee8ca951127ceb398d089c151e041c4414babc709b5152a03e4abc2174e-89Ee5cd5da656eb225C-85F1738344453a155727c21-699fc93072d608a3f4a248cB9e5faa621c1d8e0b7d52497e4f6da73d22ff46c20ef8deb00b47796b4926a6d09zC28cd7367fde69452acfa54ecaf-053caa95_3f9b1bd_4198da7d4248bfdc825ac3_0a618d1-b01a53b44a389643f408b93333d79afbb4a-f1e4ab98312ce836a1a3a3',
        headers: { 
          'Content-Type': ‘application/json'
        },
        data : data
      };

    axios(config)
      .then(function (response) {
        console.log(JSON.stringify(response.data));
      })
      .catch(function (error) {
        console.log(error);
      });
}

GET App Prompts Response:

{
    “emails”: [
        {
            “action”: “SEND_EMAIL”,
            “email_template”: {
                “body”: “”,
                “options”: {
                    “portal_send_to_applicant”: true,
                    “portal_send_to_utility”: true,
                    “portal_user_editable”: true
                },
                “subject”: “ACTION REQUIRED - APPLICATION_3246638 - \”Susquehanna Southeast Route\” - Status set to Attacher Acceptance”,
                “addresses”: {},
                “to” “”,
                “cc”: “”
            },
            “order”: 7,
            “$key”: “-OSiamw8IAMEgpSIEm1S”
        }
    ],
    “prompts”: [
        {
            “attribute”: “note”,
            “default_value”: “Default Value”,
            “order”: 0,
            “required”: true,
            “type”: “UPDATE_APPLICATION”,
            “$value”: “Default Note”
        }
    ]
}

PATCH Update App Status

Message: workflow-management.katapultpro.com/api/v2/application/takeAppAction/:jobId?api_key={{api-key}}

Average token cost: TBD

This PATCH Update App Status request allows you to essentially “click” an action button, “fill out” any prompt that may pop up, and move the application along in its process. For the payload body, essentially you’ll want to take the response from the GET App Prompts request and modify some of the values to suit your needs.

Query Params

Parameter	Value	Description	Required?
api_key	`{{api-key}}`	Replace `{{api-key}}` with your API key	Yes

Path Variables

Variable	Replace With
:appId	The valid Id for the application you are accessing

Example Payload Body:

{
    “emails”: [
        {
            “action”: “SEND_EMAIL”,
            “email_template”: {
                “body”: “”,
                “options”: {
                    “portal_send_to_applicant”: true,
                    “portal_send_to_utility”: true,
                    “portal_user_editable”: true
                },
                “subject”: “ACTION REQUIRED - APPLICATION_3246638 - \”Susquehanna Southeast Route\” - Status set to Attacher Acceptance”,
                “addresses”: {},
                “to” “”,
                “cc”: “”
            },
            “order”: 7,
            “$key”: “-OSiamw8IAMEgpSIEm1S”
        }
    ],
    “prompts”: [
        {
            “attribute”: “note”,
            “default_value”: “Default Value”,
            “order”: 0,
            “required”: true,
            “type”: “UPDATE_APPLICATION”,
            “$value”: “Default Note”
        }
    ]
}

Example PATCH Update App Status Request:

var axios = require(‘axios’);
var data = JSONstringify( {{put_payload_body_in_here}} );
var config = {
        method: '{{put_the_right_method_here}}',
        maxBodyLength: Infinity,
        url: '{{put_url_here}}',
        headers: { 
          'Content-Type': ‘application/json'
        },
        data : data
      };

    axios(config)
      .then(function (response) {
        console.log(JSON.stringify(response.data));
      })
      .catch(function (error) {
        console.log(error);
      });
}

PATCH Update App Status Response:

{
“message”: “Success”
}

Navigation Menu

Uh oh!

Katapult Pro V2 Documentation

🚀 A newer API is available — use Katapult Pro API v3

API Key Generation

Rate limit

Baseline Url

GET Welcome Message

GET User List

GET Job List

GET Updated Jobs List

GET Updated Nodes List

GET Attribute Tracking List

GET Job Data

GET Partial Job Data

GET Photo URL

GET Pages

POST Create Node

POST Create Job

PATCH Update Node on Job

PUT Upload Photo To Node

PUT Upload Photo To Section

POST Upload Photo Data

PATCH Replace Photo Data

DELETE Delete Photo Data

PUT Archive a Job

PUT Un-Archive a Job

GET App Buttons

GET App Prompts

PATCH Update App Status

Uh oh!

FilesExpand file tree

DocumentationV2.MD

Latest commit

History

DocumentationV2.MD

File metadata and controls

Katapult Pro V2 Documentation

🚀 A newer API is available — use Katapult Pro API v3

API Key Generation

Rate limit

Baseline Url

GET Welcome Message

GET User List

GET Job List

GET Updated Jobs List

GET Updated Nodes List

GET Attribute Tracking List

GET Job Data

GET Partial Job Data

GET Photo URL

GET Pages

POST Create Node

POST Create Job

PATCH Update Node on Job

PUT Upload Photo To Node

PUT Upload Photo To Section

POST Upload Photo Data

PATCH Replace Photo Data

DELETE Delete Photo Data

PUT Archive a Job

PUT Un-Archive a Job

GET App Buttons

GET App Prompts

PATCH Update App Status