---
title: "Group accessible records by actual shared column values"
method: GET
path: "/v1/workspace/collections/{collection_id}/relationships"
---

# Group accessible records by actual shared column values

`GET /v1/workspace/collections/{collection_id}/relationships`

## Request

- Base URL: `https://api.specstream.ai`
- URL: `https://api.specstream.ai/v1/workspace/collections/{collection_id}/relationships`
- Auth: API key in header `Authorization`

## Path parameters

- `collection_id` string, required

## Query parameters

- `field_id` string

## Response `200`

Group accessible records by actual shared column values

- object
  - `data` RelationshipData, required
    - `collection_id` string, required
    - `version` integer, required
    - `field_id` string, nullable, required
    - `label` string, nullable, required
    - `groups` object[], required
    - `missing` integer, required

## Other responses

- `default`: Error envelope

---

[API](https://skmtc.dev/specstream/apis/specstream-api.md) · [All operations](https://skmtc.dev/specstream/apis/specstream-api/llms.txt) · [OpenAPI document](https://skmtc.dev/specstream/apis/specstream-api/revisions/5a9f51143a13?raw)