> 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/cms/api-cms-tour.md).

# /api/cms/tour

## GET /api/cms/tour

> Get tour details

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

## POST /api/cms/tour

> Add Tour

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/tour"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_cms_tour":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["name","cms_theme_id"]}}},"paths":{"/api/cms/tour":{"post":{"description":"Add Tour","tags":["/api/cms/tour"],"parameters":[{"name":"name","in":"query","schema":{"type":"string"},"required":true},{"name":"settings","in":"query","schema":{"type":"string"},"required":false},{"name":"fields_section","in":"query","schema":{"type":"string"},"required":false},{"name":"cms_theme_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"deployment","in":"query","schema":{"default":"--notset--","type":"integer"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_cms_tour"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_cms_tour"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_cms_tour"}}}}}}}}}
```

## DELETE /api/cms/tour

> Delete tour

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

## PATCH /api/cms/tour

> Update tour

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/cms/tour"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_cms_tour":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["cms_area_id"]}}},"paths":{"/api/cms/tour":{"patch":{"description":"Update tour","tags":["/api/cms/tour"],"parameters":[{"name":"cms_area_id","in":"query","schema":{"type":"integer"},"required":true},{"name":"name","in":"query","schema":{"type":"string"},"required":false},{"name":"settings","in":"query","schema":{"type":"string"},"required":false},{"name":"fields_section","in":"query","schema":{"type":"string"},"required":false},{"name":"sites","in":"query","schema":{"type":"string"},"required":false},{"name":"parent_tourid","in":"query","schema":{"type":"integer"},"required":false},{"name":"cms_theme_id","in":"query","schema":{"type":"integer"},"required":false},{"name":"deployment","in":"query","schema":{"default":"--notset--","type":"integer"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_cms_tour"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_cms_tour"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_cms_tour"}}}}}}}}}
```