# chat.sprk.convo.getConvoAvailability

> Published by [sprk.so](https://lexicon.garden/identity/did:plc:cveom2iroj3mt747sd4qqnr2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/chat.sprk.convo.getConvoAvailability)
- [Documentation](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/chat.sprk.convo.getConvoAvailability/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:cveom2iroj3mt747sd4qqnr2/chat.sprk.convo.getConvoAvailability/examples)

## Definitions

### `chat.sprk.convo.getConvoAvailability`

**Type**: `query`

Get whether the requester and the other members can chat. If an existing convo is found for these members, it is returned.

#### Parameters

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

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `convo` | `ref` → `chat.sprk.convo.defs#convoView` | No |  |
| `canChat` | `boolean` | Yes |  |

## Raw Schema

```json
{
  "id": "chat.sprk.convo.getConvoAvailability",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "canChat"
          ],
          "properties": {
            "convo": {
              "ref": "chat.sprk.convo.defs#convoView",
              "type": "ref"
            },
            "canChat": {
              "type": "boolean"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "members"
        ],
        "properties": {
          "members": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "did"
            },
            "maxLength": 10,
            "minLength": 1
          }
        }
      },
      "description": "Get whether the requester and the other members can chat. If an existing convo is found for these members, it is returned."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```