# fyi.opensocial.getTemplateListing

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getTemplateListing)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getTemplateListing/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getTemplateListing/examples)

## Definitions

### `fyi.opensocial.getTemplateListing`

**Type**: `query`

A template shared with everyone, for its own page: what it's called, who made it, what a tab of it does at its latest version, and every version. For anyone; never one shared within a group.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes | The template, its fyi.opensocial.template in whoever made it's repo. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `description` | `string` | Yes |  |
| `entry` | `ref` → `fyi.opensocial.template#entry` | Yes | What a tab of its latest version does, its own kinds of record not yet named for any tab. |
| `hidden` | `boolean` | No | Labelled hidden, it or its latest version, by this host's moderators or a labeler it follows: left out of where people look for things to add. Tabs of it keep working. |
| `keptBy` | `integer` | No | How many groups on this host have a tab of it now, of any version. Groups elsewhere aren't counted. |
| `kinds` | `array` | No | The kinds of record it makes up, under the placeholder namespace each tab names for itself. |
| `likes` | `integer` | No | How many people like it, as this host has seen. |
| `listed` | `boolean` | No | Whoever made it asks for it to be listed: its listing says so. |
| `maker` | `ref` → `#makerView` | Yes |  |
| `name` | `string` | Yes | Its record key: lowercase letters, digits and dashes. |
| `number` | `integer` | Yes |  |
| `scan` | `ref` → `#scanView` | No | What this host's scan of every version not taken back found, each thing found saying which version. |
| `shown` | `boolean` | No | Whether this host lists it where people look for things to add: listed, kept by enough of its groups for long enough, its latest version scanned with nothing found, and nothing labelling it hidden. |
| `uri` | `string` (at-uri) | Yes |  |
| `version` | `ref` → `com.atproto.repo.strongRef` | Yes | Its latest version, which a tab added from it names. |
| `versions` | `array` | Yes | Every version, newest first. |

#### Errors

- **NotFound**

### `fyi.opensocial.getTemplateListing#makerView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `avatar` | `string` (uri) | No |  |
| `did` | `string` (did) | Yes |  |
| `displayName` | `string` | No |  |
| `group` | `boolean` | No | Whether a group made it: one this host runs. |
| `handle` | `string` (handle) | No |  |

### `fyi.opensocial.getTemplateListing#scanView`

**Type**: `object`

What this host's scan of one version found: its own kinds of record against atproto's rules, what its pages try to load or run that its frame wouldn't let them, and its sizes against this host's limits. A scan, not a person's review.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `found` | `array` | Yes | Each thing found, in a sentence. |
| `ok` | `boolean` | Yes | Nothing was found. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A template shared with everyone, for its own page: what it's called, who made it, what a tab of it does at its latest version, and every version. For anyone; never one shared within a group.",
      "errors": [
        {
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "description": {
              "type": "string"
            },
            "entry": {
              "description": "What a tab of its latest version does, its own kinds of record not yet named for any tab.",
              "ref": "fyi.opensocial.template#entry",
              "type": "ref"
            },
            "hidden": {
              "description": "Labelled hidden, it or its latest version, by this host's moderators or a labeler it follows: left out of where people look for things to add. Tabs of it keep working.",
              "type": "boolean"
            },
            "keptBy": {
              "description": "How many groups on this host have a tab of it now, of any version. Groups elsewhere aren't counted.",
              "minimum": 0,
              "type": "integer"
            },
            "kinds": {
              "description": "The kinds of record it makes up, under the placeholder namespace each tab names for itself.",
              "items": {
                "format": "nsid",
                "type": "string"
              },
              "type": "array"
            },
            "likes": {
              "description": "How many people like it, as this host has seen.",
              "minimum": 0,
              "type": "integer"
            },
            "listed": {
              "description": "Whoever made it asks for it to be listed: its listing says so.",
              "type": "boolean"
            },
            "maker": {
              "ref": "#makerView",
              "type": "ref"
            },
            "name": {
              "description": "Its record key: lowercase letters, digits and dashes.",
              "type": "string"
            },
            "number": {
              "minimum": 1,
              "type": "integer"
            },
            "scan": {
              "description": "What this host's scan of every version not taken back found, each thing found saying which version.",
              "ref": "#scanView",
              "type": "ref"
            },
            "shown": {
              "description": "Whether this host lists it where people look for things to add: listed, kept by enough of its groups for long enough, its latest version scanned with nothing found, and nothing labelling it hidden.",
              "type": "boolean"
            },
            "uri": {
              "format": "at-uri",
              "type": "string"
            },
            "version": {
              "description": "Its latest version, which a tab added from it names.",
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "versions": {
              "description": "Every version, newest first.",
              "items": {
                "ref": "fyi.opensocial.listTemplates#versionView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "uri",
            "name",
            "description",
            "maker",
            "version",
            "number",
            "entry",
            "versions"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "uri": {
            "description": "The template, its fyi.opensocial.template in whoever made it's repo.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "uri"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "makerView": {
      "properties": {
        "avatar": {
          "format": "uri",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "group": {
          "description": "Whether a group made it: one this host runs.",
          "type": "boolean"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        }
      },
      "required": [
        "did"
      ],
      "type": "object"
    },
    "scanView": {
      "description": "What this host's scan of one version found: its own kinds of record against atproto's rules, what its pages try to load or run that its frame wouldn't let them, and its sizes against this host's limits. A scan, not a person's review.",
      "properties": {
        "found": {
          "description": "Each thing found, in a sentence.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "ok": {
          "description": "Nothing was found.",
          "type": "boolean"
        }
      },
      "required": [
        "ok",
        "found"
      ],
      "type": "object"
    }
  },
  "id": "fyi.opensocial.getTemplateListing",
  "lexicon": 1
}
```