# at.ducs.relationships.getRelationships

> Published by [ducs.at](https://lexicon.garden/identity/did:plc:c5ljrscuf2xu4oovnafzoqlg)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:c5ljrscuf2xu4oovnafzoqlg/at.ducs.relationships.getRelationships)
- [Documentation](https://lexicon.garden/lexicon/did:plc:c5ljrscuf2xu4oovnafzoqlg/at.ducs.relationships.getRelationships/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:c5ljrscuf2xu4oovnafzoqlg/at.ducs.relationships.getRelationships/examples)

## Definitions

### `at.ducs.relationships.getRelationships`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `beforeDid` | `string` (did) | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `relationships` | `array` | No |  |

## Raw Schema

```json
{
  "id": "at.ducs.relationships.getRelationships",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "properties": {
            "relationships": {
              "type": "array",
              "items": {
                "ref": "at.ducs.relationships.defs#relationship",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 20
          },
          "beforeDid": {
            "type": "string",
            "format": "did"
          }
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```