---
agentTools:
  projectIndex: https://docs.archisnapper.com/llms.txt
---

# Creating a project

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://app3.archisnapper.com/api/public/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/sites": {
      "post": {
        "summary": "Creating a project",
        "description": "",
        "operationId": "creating-a-project",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "auth_token"
                ],
                "properties": {
                  "auth_token": {
                    "type": "string",
                    "description": "Your authentication token."
                  },
                  "site": {
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Your Project name"
                      },
                      "unique_id": {
                        "type": "string",
                        "description": "Your project unique ID. Has to be unique."
                      },
                      "layout_name": {
                        "type": "string",
                        "description": "Your layout name. Will be defaulted to the first available layout if this parameter is missing."
                      },
                      "description": {
                        "type": "string",
                        "description": "Your project description."
                      },
                      "street": {
                        "type": "string",
                        "description": "Address line 1."
                      },
                      "city_state_zipcode": {
                        "type": "string",
                        "description": "Address line 2."
                      },
                      "country": {
                        "type": "string",
                        "description": "The international country code. Example \"BE\" for Belgium, \"GB\" for United Kingdom, \"US\" for the United States."
                      },
                      "additional_info": {
                        "type": "string",
                        "description": "Custom field."
                      },
                      "additional_info_2": {
                        "type": "string",
                        "description": "Custom field."
                      },
                      "additional_info_3": {
                        "type": "string",
                        "description": "Custom field."
                      },
                      "additional_info_4": {
                        "type": "string",
                        "description": "Custom field."
                      },
                      "additional_info_5": {
                        "type": "string",
                        "description": "Custom field."
                      },
                      "first_visit_number": {
                        "type": "string",
                        "description": "Report numbering will start at this number."
                      },
                      "client_internal_unique_id": {
                        "type": "string",
                        "description": "Add your own id for the project, you can then use this 'client_internal_unique_id' instead of the ArchiSnapper id in order to update projects, add contacts, reports etc..."
                      },
                      "skip_default_users": {
                        "type": "boolean",
                        "description": "This allows to skip default user access for this project. By default, all existing users will get access to a project. Setting this to \"true\" will only give the admin user access."
                      },
                      "visits_frequency": {
                        "type": "integer",
                        "description": "Number of days",
                        "format": "int32"
                      },
                      "visits_enabled": {
                        "type": "boolean",
                        "description": "To enable/disable visit days and display project on map when visit is due"
                      },
                      "number_of_reports_needed": {
                        "type": "integer",
                        "description": "Number of reports required to make a visit",
                        "format": "int32"
                      },
                      "soonest_visit_date": {
                        "type": "string",
                        "description": "First (or next) inspection date",
                        "format": "date"
                      }
                    },
                    "required": [
                      "name",
                      "unique_id"
                    ],
                    "type": "object"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "201",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"site_id\": 999999,\n    \"unique_id\": \"uniid\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "site_id": {
                      "type": "integer",
                      "example": 999999,
                      "default": 0
                    },
                    "unique_id": {
                      "type": "string",
                      "example": "uniid"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"errors\": {\n        \"account_setting\": [\n            \"is not included in the list\"\n        ]\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "object",
                      "properties": {
                        "account_setting": {
                          "type": "array",
                          "items": {
                            "type": "string",
                            "example": "is not included in the list"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "63053e399807941f67a925c7:558a6e9275eaf50d004e4bfa"
}
```