# dev.tsunagite.listSongs

> Published by [tsunagite.dev](https://lexicon.garden/identity/did:plc:pz4sp2vf5w26wnaee253gfms)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.listSongs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.listSongs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.listSongs/examples)

## Definitions

### `dev.tsunagite.listSongs`

**Type**: `query`

Batch song fetch

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `game` | `string` (at-uri) | Yes | The game to find song records for. |
| `limit` | `integer` | No | How many records to return. |
| `owner` | `string` (at-identifier) | No | The handle or DID of the account to filter results to. |
| `cursor` | `string` | No | Opaque string - receive from a previous request as the `cursor` value |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `songs` | `array` | Yes |  |
| `cursor` | `string` | No | Opaque string - pass back in a future request as the `cursor` value |

## Raw Schema

```json
{
  "id": "dev.tsunagite.listSongs",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "songs"
          ],
          "properties": {
            "songs": {
              "type": "array",
              "items": {
                "ref": "dev.tsunagite.song",
                "type": "ref"
              }
            },
            "cursor": {
              "type": "string",
              "description": "Opaque string - pass back in a future request as the `cursor` value"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "game"
        ],
        "properties": {
          "game": {
            "type": "string",
            "format": "at-uri",
            "description": "The game to find song records for."
          },
          "limit": {
            "type": "integer",
            "default": 20,
            "maximum": 100,
            "description": "How many records to return."
          },
          "owner": {
            "type": "string",
            "format": "at-identifier",
            "description": "The handle or DID of the account to filter results to."
          },
          "cursor": {
            "type": "string",
            "description": "Opaque string - receive from a previous request as the `cursor` value"
          }
        }
      },
      "description": "Batch song fetch"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```