---
title: "List entities"
method: GET
path: "/api/v1/catalog"
tags: ["Catalog Entities"]
---

# List entities

`GET /api/v1/catalog`

List all entities across the Service, Resource and Domain Catalogs.

This API returns summary data for each entity, so refer to the retrieve entity method to lookup more details for a single entity.

## Query parameters

- `groups` string[]
- `owners` string[]
- `hierarchyDepth` string
- `gitRepositories` string[]
- `includeHierarchyFields` string[]
- `types` string[]
- `query` string
- `includeArchived` boolean
- `includeMetadata` boolean
- `includeLinks` boolean
- `includeSlackChannels` boolean
- `includeOwners` boolean
- `includeNestedFields` string[]
- `pageSize` integer, required
- `page` integer, required

## Response `200`

Successfully found entities

- ListCatalogEntities — List of all catalog entities, including services, resources, and domains. Use the \"type\" field to determine what type each entity is.
  - `entities` EntityDetailsSummary[], required
    - `description` string — Description of the entity visible in the Service, Resource, or Domain Catalog. This may contain markdown.
    - `git` GitDetails — Metadata about the entity's git repository
      - `alias` string — Custom defined alias (this is only relevant if you have opted into multi account support)
      - `basepath` string — If the entity is in a monorepo (e.g. in a subdirectory), this field defines the subdirectory
      - `provider` string, required — Name of the Git provider
      - `repository` string, required — Repository name as defined in your Git provider
      - `repositoryUrl` string, required — URL of the Git repository
    - `groups` string[], required — Corresponds to the x-cortex-groups field in the Catalog Descriptor
    - `hierarchy` EntityHierarchyDetails, required — Hierarchy details for the entity. Includes both the parent & the children chains.
      - `children` HierarchyChildNode[], required — Nested children chain for the specific entity.
        - `children` HierarchyChildNode, required — recursive
        - `definition` JsonNode
        - `description` string
        - `groups` string[] — List of groups for this node. Only included if includeHierarchyFields contains groups
        - `id` string, required
        - `name` string, required
        - `tag` string, required
        - `type` string, required
      - `parents` HierarchyParentNode[], required — Nested parent chain for the specific entity.
        - `definition` JsonNode
        - `description` string
        - `groups` string[] — List of groups for this node. Only included if includeHierarchyFields contains groups
        - `id` string, required
        - `name` string, required
        - `parents` HierarchyParentNode, required — recursive
        - `tag` string, required
        - `type` string, required
    - `id` string, required — Unique, immutable, 18-character auto-generated identifier for the entity.
    - `isArchived` boolean, required
    - `lastUpdated` string, date-time, required — Last updated ISO timestamp
    - `links` Link[], required — Relevant links for the entity. Corresponds to the x-cortex-links field in the entity descriptor
      - `description` string — An optional description of the link
      - `name` string, required — Human-readable name for the link visible in the Catalog
      - `type` string, required — Corresponds to the type field in a link definition provided in the Catalog Descriptor
      - `url` string, required
    - `members` TeamMember[]
      - `description` string — Description of the team member
      - `email` string — Email of the team member
      - `name` string — Name of the team member
      - `roles` Role[], required
        - `name` string, required — Name of the role
        - `source` string — Source of the role if pulled in through integration. This will be blank if manually defined in Cortex.
      - `sources` TeamMemberSource[], required
        - `externalGroupId` string
        - `externalId` string
        - `provider` 'ACTIVE_DIRECTORY' | 'BAMBOO_HR' | 'GITHUB' | 'GITLAB' | 'GOOGLE' | 'OKTA' | 'OPSGENIE' | 'WORKDAY' | 'SERVICE_NOW'
        - `type` 'ENTITY_DEFINED' | 'IDP_GROUP', required
    - `metadata` Metadata[] — Custom data key/values associated with the entity.
      - `key` string, required — The custom data key, referred to in CQL as custom("key")
      - `value` JsonNode, required
    - `name` string, required — Human-readable name for the entity
    - `owners` OwnersDetails — Entity owners information
      - `individuals` IndividualOwnerDetails[], required
        - `description` string — Description of the email owner
        - `email` string, required
      - `teams` TeamDetails[], required
        - `description` string — Description of the team entity
        - `id` string, required — Unique, immutable, 18-character auto-generated identifier for the team entity
        - `inheritance` 'APPEND' | 'FALLBACK' | 'NONE' — Inheritance type, only defined for domain entities
        - `isArchived` boolean, required
        - `name` string, required — Human-readable name for the team entity
        - `provider` 'ACTIVE_DIRECTORY' | 'BAMBOO_HR' | 'CORTEX' | 'GITHUB' | 'GITLAB' | 'GOOGLE' | 'OKTA' | 'OPSGENIE' | 'WORKDAY' | 'SERVICE_NOW' — If defined, indicates the ownership provider the team slug references
        - `tag` string, required — Unique identifier for the team entity. Corresponds to the x-cortex-tag field in the entity descriptor
    - `slackChannels` SlackChannelDetails[], required
      - `description` string — Description of the Slack channel
      - `name` string, required — Name of the Slack channel
      - `notificationsEnabled` boolean, required — Whether notifications are enabled for this channel
    - `tag` string, required — Unique identifier for the entity. Corresponds to the x-cortex-tag field in the entity descriptor.
    - `type` string, required — Type of the entity. Corresponds to the x-cortex-type field in the entity descriptor or 'service' for services.
  - `page` integer, required — Current page number, 0-indexed
  - `total` integer, required — Total number of results
  - `totalPages` integer, required — Total number of pages

## Other responses

- `400` — Invalid filters
- `429` — The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

---

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