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

# Get a list of entities

`GET /api/v2/catalog/entity`

Get a list of entities from Software Catalog.

## Query parameters

- `page[offset]` integer
- `page[limit]` integer
- `filter[id]` string
- `filter[ref]` string
- `filter[name]` string
- `filter[kind]` string
- `filter[owner]` string
- `filter[relation][type]` 'RelationTypeOwns' | 'RelationTypeOwnedBy' | 'RelationTypeDependsOn' | 'RelationTypeDependencyOf' | 'RelationTypePartsOf' | 'RelationTypeHasPart' | 'RelationTypeOtherOwns' | 'RelationTypeOtherOwnedBy' | 'RelationTypeImplementedBy' | 'RelationTypeImplements' — Supported relation types.
- `filter[exclude_snapshot]` string
- `include` 'schema' | 'raw_schema' | 'oncall' | 'incident' | 'relation' — Supported include types.
- `includeDiscovered` boolean

## Response `200`

OK

- ListEntityCatalogResponse — List entity response.
  - `data` EntityData[] — List of entity data.
    - `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.
  - `included` ListEntityCatalogResponseIncludedItem[] — List entity response included.
    - union — List entity response included item.
      - EntityResponseIncludedSchema — Included detail entity schema.
        - `attributes` EntityResponseIncludedSchemaAttributes — Included schema.
          - `schema` union — Entity schema v3.
            - EntityV3Service — Schema for service entities.
              - …
            - EntityV3Datastore — Schema for datastore entities.
              - …
            - EntityV3Queue — Schema for queue entities.
              - …
            - EntityV3System — Schema for system entities.
              - …
            - EntityV3API — Schema for API entities.
              - …
        - `id` string — Entity ID.
        - `type` 'schema' — Schema type.
      - EntityResponseIncludedRawSchema — Included raw schema.
        - `attributes` EntityResponseIncludedRawSchemaAttributes — Included raw schema attributes.
          - `rawSchema` string — Schema from user input in base64 encoding.
        - `id` string — Raw schema ID.
        - `type` 'rawSchema' — Raw schema type.
      - EntityResponseIncludedRelatedEntity — Included related entity.
        - `attributes` EntityResponseIncludedRelatedEntityAttributes — Related entity attributes.
          - `kind` string — Entity kind.
          - `name` string — Entity name.
          - `namespace` string — Entity namespace.
          - `type` string — Entity relation type to the associated entity.
        - `id` string — Entity UUID.
        - `meta` EntityResponseIncludedRelatedEntityMeta — Included related entity meta.
          - `createdAt` string, date-time — Entity creation time.
          - `defined_by` string — Entity relation defined by.
          - `modifiedAt` string, date-time — Entity modification time.
          - `source` string — Entity relation source.
        - `type` 'relatedEntity' — Related entity.
      - EntityResponseIncludedOncall — Included oncall.
        - `attributes` EntityResponseIncludedRelatedOncallAttributes — Included related oncall attributes.
          - `escalations` EntityResponseIncludedRelatedOncallEscalationItem[] — Oncall escalations.
            - `email` string — Oncall email.
            - `escalationLevel` integer — Oncall level.
            - `name` string — Oncall name.
          - `provider` string — Oncall provider.
        - `id` string — Oncall ID.
        - `type` 'oncall' — Oncall type.
      - EntityResponseIncludedIncident — Included incident.
        - `attributes` EntityResponseIncludedRelatedIncidentAttributes — Incident attributes.
          - `createdAt` string, date-time — Incident creation time.
          - `htmlURL` string — Incident URL.
          - `provider` string — Incident provider.
          - `status` string — Incident status.
          - `title` string — Incident title.
        - `id` string — Incident ID.
        - `type` 'incident' — Incident description.
  - `links` ListEntityCatalogResponseLinks — List entity response links.
    - `next` string — Next link.
    - `previous` string — Previous link.
    - `self` string — Current link.
  - `meta` EntityResponseMeta — Entity metadata.
    - `count` integer — Total entities 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)