# us.off-the-clock.admin.listRecords

> Published by [off-the-clock.us](https://lexicon.garden/identity/did:plc:tevv7zpavtjtsvqrrwwipobt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.admin.listRecords)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.admin.listRecords/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.admin.listRecords/examples)

## Definitions

### `us.off-the-clock.admin.listRecords`

**Type**: `query`

A community space's records, newest first, hidden ones included. Effective admins and the community identity only.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `collection` | `string` (nsid) | No |  |
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |
| `space` | `string` | Yes | A registered pair's content space: its TID or <space-type>/<space-id>. |

#### Output

**Encoding**: `application/json`

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

#### Errors

- **NotAdmin**
- **InvalidRequest**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "A community space's records, newest first, hidden ones included. Effective admins and the community identity only.",
      "errors": [
        {
          "name": "NotAdmin"
        },
        {
          "name": "InvalidRequest"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "records": {
              "items": {
                "ref": "us.off-the-clock.admin.defs#record",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "records"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "collection": {
            "format": "nsid",
            "type": "string"
          },
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "space": {
            "description": "A registered pair's content space: its TID or <space-type>/<space-id>.",
            "maxLength": 512,
            "type": "string"
          }
        },
        "required": [
          "space"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "us.off-the-clock.admin.listRecords",
  "lexicon": 1
}
```