---
title: "List relationship definitions in the registry"
method: GET
path: "/sources/{sourceKey}/v1/relationship-definitions"
tags: ["Relationship Definitions"]
---

# List relationship definitions in the registry

`GET /sources/{sourceKey}/v1/relationship-definitions`

List relationship definitions in the registry.

## Path parameters

- `sourceKey` string, required

## Query parameters

- `page` integer
- `perPage` integer

## Response `200`

A successful response.

- object
  - `meta` V1ListResponseMeta, required
    - `numPages` integer, required
    - `page` integer, required
    - `perPage` integer, required
    - `total` integer, required
  - `data` V1RelationshipDefinition[], required
    - `key` string
    - `from` V1RelationshipRefDefinition, required
      - `profileKey` string, required
      - `includeKey` string, required
      - `includeCardinality` '0:*' | '0:1', required
    - `to` V1RelationshipRefDefinition, required
      - `profileKey` string, required
      - `includeKey` string, required
      - `includeCardinality` '0:*' | '0:1', required
    - `description` string — Description of the relationship definition.
    - `properties` object, required

## Other responses

- `400` — Returned when the request is malformed or invalid.
- `404` — The source does not exist.

---

[API](https://skmtc.dev/clinia/apis/registry-api.md) · [All operations](https://skmtc.dev/clinia/apis/registry-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/clinia/registry-api/revisions/3a9197b11351/schema)