# org.chaoticharmonylabs.orbit.list

> Published by [chaoticharmonylabs.org](https://lexicon.garden/identity/did:plc:mqmbvlnt6fcqqboqqcg3b7d4)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mqmbvlnt6fcqqboqqcg3b7d4/org.chaoticharmonylabs.orbit.list)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mqmbvlnt6fcqqboqqcg3b7d4/org.chaoticharmonylabs.orbit.list/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mqmbvlnt6fcqqboqqcg3b7d4/org.chaoticharmonylabs.orbit.list/examples)

## Definitions

### `org.chaoticharmonylabs.orbit.list`

**Type**: `query`

List orbits for the authenticated user.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `cursor` | `string` | No | Pagination cursor |

#### Output

**Encoding**: `application/json`

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

## Raw Schema

```json
{
  "id": "org.chaoticharmonylabs.orbit.list",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "orbits"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "orbits": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "uri",
                  "cid",
                  "value"
                ],
                "properties": {
                  "cid": {
                    "type": "string",
                    "format": "cid"
                  },
                  "uri": {
                    "type": "string",
                    "format": "at-uri"
                  },
                  "value": {
                    "ref": "org.chaoticharmonylabs.orbit.defs#orbit",
                    "type": "ref"
                  }
                }
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string",
            "description": "Pagination cursor"
          }
        }
      },
      "description": "List orbits for the authenticated user."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```