# rsvp.atmo.space.listRecords

> Published by [atmo.rsvp](https://lexicon.garden/identity/did:plc:b63bmauox6z5rbibwrhxrdnw)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:b63bmauox6z5rbibwrhxrdnw/rsvp.atmo.space.listRecords)
- [Documentation](https://lexicon.garden/lexicon/did:plc:b63bmauox6z5rbibwrhxrdnw/rsvp.atmo.space.listRecords/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:b63bmauox6z5rbibwrhxrdnw/rsvp.atmo.space.listRecords/examples)

## Definitions

### `rsvp.atmo.space.listRecords`

**Type**: `query`

List records of a given collection within a space. Access is governed by the space's collection policy.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `byUser` | `string` (did) | No | Only return records authored by this DID. |
| `cursor` | `string` | No |  |
| `spaceUri` | `string` (at-uri) | Yes |  |
| `collection` | `string` (nsid) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `records` | `array` | Yes |  |

#### Errors

- **NotFound**
- **Forbidden**

## Raw Schema

```json
{
  "id": "rsvp.atmo.space.listRecords",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "Forbidden"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "records"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "records": {
              "type": "array",
              "items": {
                "ref": "rsvp.atmo.space.defs#recordView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "spaceUri",
          "collection"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 200,
            "minimum": 1
          },
          "byUser": {
            "type": "string",
            "format": "did",
            "description": "Only return records authored by this DID."
          },
          "cursor": {
            "type": "string"
          },
          "spaceUri": {
            "type": "string",
            "format": "at-uri"
          },
          "collection": {
            "type": "string",
            "format": "nsid"
          }
        }
      },
      "description": "List records of a given collection within a space. Access is governed by the space's collection policy."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```