# fyi.opensocial.getSiteRecord

> 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.getSiteRecord)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getSiteRecord/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.getSiteRecord/examples)

## Definitions

### `fyi.opensocial.getSiteRecord`

**Type**: `query`

One public record a group's site reads, by URI, from the host's index: of a collection the site reads from everyone (answered to anyone), or the group's own or a member's of a collection it reads (a member's to members only). Anything else isn't the site's to read, except to whoever may change the site, for whom the host reads it from the account's own server: what a tab is about, when it's made.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `group` | `string` (did) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | No |  |
| `createdAt` | `string` (datetime) | No |  |
| `handle` | `string` (handle) | No |  |
| `repo` | `string` (did) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `value` | `unknown` | Yes |  |

#### Errors

- **NotFound**
- **NotDeclared**
- **NotAuthorized**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "One public record a group's site reads, by URI, from the host's index: of a collection the site reads from everyone (answered to anyone), or the group's own or a member's of a collection it reads (a member's to members only). Anything else isn't the site's to read, except to whoever may change the site, for whom the host reads it from the account's own server: what a tab is about, when it's made.",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "NotDeclared"
        },
        {
          "name": "NotAuthorized"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cid": {
              "format": "cid",
              "type": "string"
            },
            "createdAt": {
              "format": "datetime",
              "type": "string"
            },
            "handle": {
              "format": "handle",
              "type": "string"
            },
            "repo": {
              "format": "did",
              "type": "string"
            },
            "uri": {
              "format": "at-uri",
              "type": "string"
            },
            "value": {
              "type": "unknown"
            }
          },
          "required": [
            "uri",
            "repo",
            "value"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "format": "did",
            "type": "string"
          },
          "uri": {
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "group",
          "uri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.getSiteRecord",
  "lexicon": 1
}
```