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

# Share Templates

Saved share card layouts for the project; integrations list templates or pair them with reviews for share image generation.

## List Share Templates

> Return every saved share template including default flag and layout settings.

```json
{"openapi":"3.0.3","info":{"title":"MGR Project API","version":"1.0.0"},"tags":[{"description":"Saved share card layouts for the project; integrations list templates or pair them with reviews for share image generation.","name":"Share Templates"}],"servers":[{"url":"https://api.moregoodreviews.com/project"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"ApiKey"}}},"paths":{"/share-templates":{"get":{"tags":["Share Templates"],"summary":"List Share Templates","operationId":"listShareTemplates","description":"Return every saved share template including default flag and layout settings.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Paginated-style success wrapper with an array of templates in data.","properties":{"success":{"type":"boolean","description":"Indicates whether the request completed successfully."},"code":{"type":"integer","description":"Application-level status code returned by this API."},"data":{"type":"array","description":"Saved share templates ordered by name then id.","items":{"type":"object","description":"One share template owned by the authenticated project.","properties":{"id":{"type":"integer","description":"Unique numeric identifier for this share template."},"uuid":{"type":"string","description":"Stable UUID for this share template."},"name":{"type":"string","description":"Human-readable name shown when picking a template."},"is_default":{"type":"boolean","description":"Whether this template is the project default when sharing."},"settings":{"type":"object","description":"Share card options such as colors, ratio, and visible blocks.","nullable":true,"properties":{"font_family":{"type":"string","description":"Font family name for card typography."},"header_background_color":{"type":"string","description":"Header bar background color hex value."},"header_text_color":{"type":"string","description":"Header text color hex value."},"name_convention":{"type":"string","description":"Display format for reviewer or customer names.","enum":["full_name","first_name_last_initial","initials","hidden"]},"ratio":{"type":"string","description":"Output aspect ratio for the share PNG.","enum":["1:1","4:5","9:16"]},"review_background_color":{"type":"string","description":"Card body background color hex value."},"review_star_color":{"type":"string","description":"Star tint color hex value when ratings are visible."},"review_text":{"type":"string","nullable":true,"description":"Optional overridden quote text stored on the template."},"review_text_color":{"type":"string","description":"Quote text color hex value."},"show_avatar":{"type":"integer","description":"Whether the author avatar shows when present.","enum":[0,1]},"show_company":{"type":"integer","description":"Whether the organization name shows with the author.","enum":[0,1]},"show_date":{"type":"integer","description":"Whether to show the formatted review date in the footer.","enum":[0,1]},"show_header":{"type":"integer","description":"Whether to show project icon and header bar.","enum":[0,1]},"show_rating":{"type":"integer","description":"Whether to show numeric star rating glyphs.","enum":[0,1]},"show_source":{"type":"integer","description":"Whether to show originating review platform badges.","enum":[0,1]}}},"created_at":{"type":"integer","description":"Unix timestamp when the template was saved."},"updated_at":{"type":"integer","description":"Unix timestamp when template settings last changed."}}}}}}}}}}}}}}
```

## Delete Share Template

> Remove a share template and promote another default when the deleted row was default.

```json
{"openapi":"3.0.3","info":{"title":"MGR Project API","version":"1.0.0"},"tags":[{"description":"Saved share card layouts for the project; integrations list templates or pair them with reviews for share image generation.","name":"Share Templates"}],"servers":[{"url":"https://api.moregoodreviews.com/project"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"ApiKey"}}},"paths":{"/share-templates/{id}":{"delete":{"tags":["Share Templates"],"summary":"Delete Share Template","operationId":"deleteShareTemplate","description":"Remove a share template and promote another default when the deleted row was default.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","nullable":false},"description":"Unique numeric identifier for the share template."}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Object confirming the share template was deleted.","properties":{"success":{"type":"boolean","description":"Indicates whether the request completed successfully."},"code":{"type":"integer","description":"Application-level status code returned by this API."}}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.moregoodreviews.com/platform/api-reference/share-templates.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.