The simplest way to try out the Scanifly API locally is by using Postman. You can import the collection below into your local Postman application and start sending requests. You will need to be set up with an integration account and access token. Please contact your Scanifly Account Executive for more details or email us at [email protected].

{
    "info": {
        "_postman_id": "be5ae7f8-01b3-48fe-b341-28a299d66b9d",
        "name": "Scanifly Public API",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "item": [
        {
            "name": "v1",
            "item": [
                {
                    "name": "list projects",
                    "request": {
                        "method": "GET",
                        "header": [],
                        "url": {
                            "raw": "https://api.portal.scanifly.com/api/v1/projects?pageIndex=1&size=150",
                            "protocol": "https",
                            "host": [
                                "api",
                                "portal",
                                "scanifly",
                                "com"
                            ],
                            "path": [
                                "api",
                                "v1",
                                "projects"
                            ],
                            "query": [
                                {
                                    "key": "pageIndex",
                                    "value": "1",
                                    "description": "0 indexed - page you would like to request"
                                },
                                {
                                    "key": "size",
                                    "value": "150",
                                    "description": "number of items to return per page"
                                }
                            ]
                        }
                    },
                    "response": []
                },
                {
                    "name": "create project",
                    "request": {
                        "method": "POST",
                        "header": [],
                        "body": {
                            "mode": "raw",
                            "raw": "{\n    \"name\": \"test project\",\n    \"address\": \"1308 georgia blvd orlando, fl 32803\",\n    \"ownerDetails\": {\n        \"firstName\": \"Bob\",\n        \"lastName\": \"Customer\",\n        \"email\": \"[email protected]\",\n        \"phone\": \"1234356\"\n    },\n    // Geolocation is now optional. If not passed, it will be calculated automatically from the project address.\n    \"geolocation\": {\n        \"latitude\": 40.7648,\n        \"longitude\": -73.9808\n    },\n    // You can pass whatever values you want below for externalMetadata. There is no schema validation here to keep it flexible for you.\n    \"externalMetadata\": {\n        \"salesforceId\": \"foobar\"\n    }\n}",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        },
                        "url": {
                            "raw": "https://api.portal.scanifly.com/api/v1/projects",
                            "protocol": "https",
                            "host": [
                                "api",
                                "portal",
                                "scanifly",
                                "com"
                            ],
                            "path": [
                                "api",
                                "v1",
                                "projects"
                            ]
                        }
                    },
                    "response": []
                },
                {
                    "name": "get project by id",
                    "request": {
                        "method": "GET",
                        "header": [],
                        "url": {
                            "raw": "https://api.portal.scanifly.com/api/v1/projects/:projectId",
                            "protocol": "https",
                            "host": [
                                "api",
                                "portal",
                                "scanifly",
                                "com"
                            ],
                            "path": [
                                "api",
                                "v1",
                                "projects",
                                ":projectId"
                            ],
                            "variable": [
                                {
                                    "key": "projectId",
                                    "value": null,
                                    "description": "Scanifly Project ID"
                                }
                            ]
                        }
                    },
                    "response": []
                },
                {
                    "name": "get project designs by id",
                    "request": {
                        "method": "GET",
                        "header": [],
                        "url": {
                            "raw": "https://api.portal.scanifly.com/api/v1/designs/:projectId",
                            "protocol": "https",
                            "host": [
                                "api",
                                "portal",
                                "scanifly",
                                "com"
                            ],
                            "path": [
                                "api",
                                "v1",
                                "designs",
                                ":projectId"
                            ],
                            "variable": [
                                {
                                    "key": "projectId",
                                    "value": null,
                                    "description": "Scanifly Project ID"
                                }
                            ]
                        }
                    },
                    "response": []
                }
            ],
            "auth": {
                "type": "apikey",
                "apikey": [
                    {
                        "key": "value",
                        "value": "your_access_token",
                        "type": "string"
                    },
                    {
                        "key": "in",
                        "value": "query",
                        "type": "string"
                    },
                    {
                        "key": "key",
                        "value": "access_token",
                        "type": "string"
                    }
                ]
            },
            "event": [
                {
                    "listen": "prerequest",
                    "script": {
                        "type": "text/javascript",
                        "exec": [
                            ""
                        ]
                    }
                },
                {
                    "listen": "test",
                    "script": {
                        "type": "text/javascript",
                        "exec": [
                            ""
                        ]
                    }
                }
            ]
        }
    ]
}