# space.highport.admin.listSpaces

> Published by [lexicons.highport.space](https://lexicon.garden/identity/did:plc:ciygg5hma4q7ah2kxaszkyob)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.admin.listSpaces)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.admin.listSpaces/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.admin.listSpaces/examples)

## Definitions

### `space.highport.admin.listSpaces`

**Type**: `query`

Every connected space with its sync state, access expiry, and registration expiry.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Pagination cursor from a previous response. |
| `limit` | `integer` | No | Maximum entries to return. |
| `state` | `string` | No | Filter by sync state (see space.highport.defs#spaceSyncState). |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Present when more entries exist. |
| `spaces` | `array` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Every connected space with its sync state, access expiry, and registration expiry.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Present when more entries exist.",
              "type": "string"
            },
            "spaces": {
              "items": {
                "ref": "space.highport.defs#spaceView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "spaces"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Pagination cursor from a previous response.",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "description": "Maximum entries to return.",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "state": {
            "description": "Filter by sync state (see space.highport.defs#spaceSyncState).",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "space.highport.admin.listSpaces",
  "lexicon": 1
}
```