> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/site/api-site-tour.md).

# /api/site/tour

## GET /api/site/tour

> Get tour details

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/site/tour"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_site_tour":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["tourid"]}}},"paths":{"/api/site/tour":{"get":{"description":"Get tour details","tags":["/api/site/tour"],"parameters":[{"name":"tourid","in":"query","schema":{"type":"integer"},"required":true},{"name":"formatted","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"page","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_site_tour"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_site_tour"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_site_tour"}}}}}}}}}
```

## POST /api/site/tour

> Add new tour

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/site/tour"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_site_tour":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["siteid","tour","url","linkdomain"]}}},"paths":{"/api/site/tour":{"post":{"description":"Add new tour","tags":["/api/site/tour"],"parameters":[{"name":"siteid","in":"query","schema":{"type":"integer"},"required":true},{"name":"tour","in":"query","schema":{"type":"string"},"required":true},{"name":"name","in":"query","schema":{"type":"string"},"required":false},{"name":"url","in":"query","schema":{"type":"string"},"required":true},{"name":"linkdomain","in":"query","schema":{"type":"string"},"required":true},{"name":"description","in":"query","schema":{"type":"string"},"required":false},{"name":"tour_type","in":"query","schema":{"default":0,"type":"string"},"required":false},{"name":"hidden","in":"query","schema":{"default":0,"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_site_tour"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_site_tour"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_site_tour"}}}}}}}}}
```

## DELETE /api/site/tour

> Delete tour

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/site/tour"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"delete_site_tour":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["tourid"]}}},"paths":{"/api/site/tour":{"delete":{"description":"Delete tour","tags":["/api/site/tour"],"parameters":[{"name":"tourid","in":"query","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/delete_site_tour"}},"application/json":{"schema":{"$ref":"#/components/schemas/delete_site_tour"}},"application/xml":{"schema":{"$ref":"#/components/schemas/delete_site_tour"}}}}}}}}}
```

## PATCH /api/site/tour

> Edit tour

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/site/tour"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_site_tour":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["tourid"]}}},"paths":{"/api/site/tour":{"patch":{"description":"Edit tour","tags":["/api/site/tour"],"parameters":[{"name":"tourid","in":"query","schema":{"type":"integer"},"required":true},{"name":"details","in":"query","schema":{"type":"string"},"required":false},{"name":"biller","in":"query","schema":{"type":"string"},"required":false},{"name":"disable_inherit","in":"query","schema":{"default":0,"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_site_tour"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_site_tour"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_site_tour"}}}}}}}}}
```