---
title: "List relations instances"
method: GET
path: "/api/v3/directory/relations"
tags: ["directory"]
---

# List relations instances

`GET /api/v3/directory/relations`

## Request

- The document declares no server URL.
- Auth: API key in header `authorization` and API key in header `aserto-tenant-id`
- TypeScript: <https://skmtc.dev/aserto/apis/openid-authzen-access-service/docs/api/v3/directory/relations/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns list of relation instances.

## Query parameters

- `object_type` string
- `object_id` string
- `relation` string
- `subject_type` string
- `subject_id` string
- `subject_relation` string
- `with_objects` boolean
- `with_empty_subject_relation` boolean
- `page.size` integer
- `page.token` string

## Response `200`

A successful response.

- V3GetRelationsResponse
  - `objects` object
  - `page` V3PaginationResponse
    - `next_token` string
  - `results` V3Relation[]
    - `created_at` string, date-time
    - `etag` string
    - `object_id` string, required
    - `object_type` string, required
    - `relation` string, required
    - `subject_id` string, required
    - `subject_relation` string
    - `subject_type` string, required
    - `updated_at` string, date-time

## Other responses

- `default`: An unexpected error response.

## Changes

- **2025-02-17** `fddc0bd34946`: 1 info
  - api operation id `directory.v3.relations.list` removed and replaced with `directory.reader.v3.relations.list`
- **2024-01-15** `0609c211aecd`: 1 info
  - added the new optional `query` request parameter `with_empty_subject_relation`
- **2023-10-31** `68bcc990c27a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/aserto/apis/openid-authzen-access-service/changes/api/v3/directory/relations/get.md)

---

[API](https://skmtc.dev/aserto/apis/openid-authzen-access-service.md) - [All operations](https://skmtc.dev/aserto/apis/openid-authzen-access-service/llms.txt) - [OpenAPI document](https://skmtc.dev/aserto/apis/openid-authzen-access-service/revisions/5dd53d1e6d2e?raw)