# fyi.opensocial.getActorInvites

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

## Definitions

### `fyi.opensocial.getActorInvites#actorInvite`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `by` | `string` (did) | No | Who in the group sent it. |
| `createdAt` | `string` (datetime) | Yes |  |
| `group` | `ref` → `fyi.opensocial.defs#groupViewBasic` | Yes |  |
| `message` | `string` | No |  |

### `fyi.opensocial.getActorInvites`

**Type**: `query`

The caller's own invites still waiting, from the groups on this host, newest first: for a group's site, which can't read the caller's inbox. With group, that group's only.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `group` | `string` (did) | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `invites` | `array` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "actorInvite": {
      "properties": {
        "by": {
          "description": "Who in the group sent it.",
          "format": "did",
          "type": "string"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "group": {
          "ref": "fyi.opensocial.defs#groupViewBasic",
          "type": "ref"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "group",
        "createdAt"
      ],
      "type": "object"
    },
    "main": {
      "description": "The caller's own invites still waiting, from the groups on this host, newest first: for a group's site, which can't read the caller's inbox. With group, that group's only.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "invites": {
              "items": {
                "ref": "#actorInvite",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "invites"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "format": "did",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.getActorInvites",
  "lexicon": 1
}
```