# fyi.opensocial.getAssistantRequest

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

## Definitions

### `fyi.opensocial.getAssistantRequest#client`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `string` | Yes |  |
| `name` | `string` | Yes |  |

### `fyi.opensocial.getAssistantRequest`

**Type**: `query`

An assistant's pending request to connect to a group, as the member deciding sees it on the group's site: which assistant, and whether the caller may say yes: any member may.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `group` | `string` (did) | Yes |  |
| `request` | `string` | Yes | The id the group's address handed the site, as ?connect=. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `allowed` | `boolean` | Yes |  |
| `client` | `ref` → `#client` | Yes |  |

#### Errors

- **ExpiredRequest**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "client": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    },
    "main": {
      "description": "An assistant's pending request to connect to a group, as the member deciding sees it on the group's site: which assistant, and whether the caller may say yes: any member may.",
      "errors": [
        {
          "name": "ExpiredRequest"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "allowed": {
              "type": "boolean"
            },
            "client": {
              "ref": "#client",
              "type": "ref"
            }
          },
          "required": [
            "client",
            "allowed"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "format": "did",
            "type": "string"
          },
          "request": {
            "description": "The id the group's address handed the site, as ?connect=.",
            "type": "string"
          }
        },
        "required": [
          "group",
          "request"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.getAssistantRequest",
  "lexicon": 1
}
```