---
title: "Get a list of entity relations"
method: GET
path: "/api/v2/catalog/relation"
tags: ["Software Catalog"]
---

# Get a list of entity relations

`GET /api/v2/catalog/relation`

Get a list of entity relations from Software Catalog.

## Query parameters

- `page[offset]` integer
- `page[limit]` integer
- `filter[type]` 'RelationTypeOwns' | 'RelationTypeOwnedBy' | 'RelationTypeDependsOn' | 'RelationTypeDependencyOf' | 'RelationTypePartsOf' | 'RelationTypeHasPart' | 'RelationTypeOtherOwns' | 'RelationTypeOtherOwnedBy' | 'RelationTypeImplementedBy' | 'RelationTypeImplements' — Supported relation types.
- `filter[from_ref]` string
- `filter[to_ref]` string
- `include` 'entity' | 'schema' — Supported include types for relations.
- `includeDiscovered` boolean

## Response `200`

OK

- ListRelationCatalogResponse — List entity relation response.
  - `data` RelationResponse[] — Array of relation responses
    - `attributes` RelationAttributes — Relation attributes.
      - `from` RelationEntity — Relation entity reference.
        - `kind` string — Entity kind.
        - `name` string — Entity name.
        - `namespace` string — Entity namespace.
      - `to` RelationEntity — Relation entity reference.
        - `kind` string — Entity kind.
        - `name` string — Entity name.
        - `namespace` string — Entity namespace.
      - `type` 'RelationTypeOwns' | 'RelationTypeOwnedBy' | 'RelationTypeDependsOn' | 'RelationTypeDependencyOf' | 'RelationTypePartsOf' | 'RelationTypeHasPart' | 'RelationTypeOtherOwns' | 'RelationTypeOtherOwnedBy' | 'RelationTypeImplementedBy' | 'RelationTypeImplements' — Supported relation types.
    - `id` string — Relation ID.
    - `meta` RelationMeta — Relation metadata.
      - `createdAt` string, date-time — Relation creation time.
      - `definedBy` string — Relation defined by.
      - `modifiedAt` string, date-time — Relation modification time.
      - `source` string — Relation source.
    - `relationships` RelationRelationships — Relation relationships.
      - `fromEntity` RelationToEntity — Relation to entity.
        - `data` RelationshipItem — Relationship entry.
          - `id` string — Associated data ID.
          - `type` string — Relationship type.
        - `meta` EntityMeta — Entity metadata.
          - `createdAt` string — The creation time.
          - `ingestionSource` string — The ingestion source.
          - `modifiedAt` string — The modification time.
          - `origin` string — The origin.
      - `toEntity` RelationToEntity — Relation to entity.
        - `data` RelationshipItem — Relationship entry.
          - `id` string — Associated data ID.
          - `type` string — Relationship type.
        - `meta` EntityMeta — Entity metadata.
          - `createdAt` string — The creation time.
          - `ingestionSource` string — The ingestion source.
          - `modifiedAt` string — The modification time.
          - `origin` string — The origin.
    - `subtype` string — Relation subtype.
    - `type` 'relation' — Relation type.
  - `included` EntityData[] — List relation response included entities.
    - `attributes` EntityAttributes — Entity attributes.
      - `apiVersion` string — The API version.
      - `description` string — The description.
      - `displayName` string — The display name.
      - `kind` string — The kind.
      - `name` string — The name.
      - `namespace` string — The namespace.
      - `owner` string — The owner.
      - `tags` string[] — The tags.
    - `id` string — Entity ID.
    - `meta` EntityMeta — Entity metadata.
      - `createdAt` string — The creation time.
      - `ingestionSource` string — The ingestion source.
      - `modifiedAt` string — The modification time.
      - `origin` string — The origin.
    - `relationships` EntityRelationships — Entity relationships.
      - `incidents` EntityToIncidents — Entity to incidents relationship.
        - `data` RelationshipItem[] — Relationships.
          - `id` string — Associated data ID.
          - `type` string — Relationship type.
      - `oncall` EntityToOncalls — Entity to oncalls relationship.
        - `data` RelationshipItem[] — Relationships.
          - `id` string — Associated data ID.
          - `type` string — Relationship type.
      - `rawSchema` EntityToRawSchema — Entity to raw schema relationship.
        - `data` RelationshipItem — Relationship entry.
          - `id` string — Associated data ID.
          - `type` string — Relationship type.
      - `relatedEntities` EntityToRelatedEntities — Entity to related entities relationship.
        - `data` RelationshipItem[] — Relationships.
          - `id` string — Associated data ID.
          - `type` string — Relationship type.
      - `schema` EntityToSchema — Entity to detail schema relationship.
        - `data` RelationshipItem — Relationship entry.
          - `id` string — Associated data ID.
          - `type` string — Relationship type.
    - `type` string — Entity.
  - `links` ListRelationCatalogResponseLinks — List relation response links.
    - `next` string — Next link.
    - `previous` string — Previous link.
    - `self` string — Current link.
  - `meta` RelationResponseMeta — Relation response metadata.
    - `count` integer — Total relations count.
    - `includeCount` integer — Total included data count.

## Other responses

- `403` — Forbidden
- `429` — Too many requests

---

[API](https://skmtc.net/datadog/apis/api-v2.md) · [All operations](https://skmtc.net/datadog/apis/api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadog/api-v2/revisions/da68bf029e4c/schema)