---
id: catalog-instance-multiple-read
title: "Read catalog instance (all keys)"
description: "Retrieves all catalog metadata keys and values defined for the specified entity."
sidebar_label: "Read catalog instance (all keys)"
hide_title: true
hide_table_of_contents: true
api: eJztWFFv2zYQ/isE0YekUe106B4mYCiCNt0ybFmQuliBxDPO4tliQ5EKSaV1Hf334UjJlhy3dZsMfelTbJM8fvd9d7y7LLkp0YKXRp8InvIMPCgzn0jtPOgMJ0WlvCwVphZB8IR7mDueXvAXcSNrN7K9die7woXb5+OEC3SZlSUZ5yk/R28l3qBjoBRrLmIFehDgIZxioAW7AVWhYwJnUqNgM2OZz5G5EjM5kygYai/9YnCpecJLsFCgR0ugltxlORbA0yX3ixJ5yp23Us95wgup/0Q99zlPn9YJl4ToukK74AnXUNBeqTNVCeQJt3hdSYuCpzNQDjc9ORKCgRCSvoJauyD1zNgikMm8CagtutJohwP2yliGH6AgLlnE6RJGdA54nXwOegneo6WL/72AJx/HB3uT+Hf/8SOecNRVQYoYOwctP4brecIhy0ylfeOeKyEjz6AslczaPdNKKhIVnEPa6TJTRv8VgqNPAktlFgUGQ5VDy8cteyX4fE1eFKXHnbfVHeqOwzZGh5jPwbPcKOG2UvglWrqK9kk6fPLL+OAR3w5Uil1BnrzcAeI44Q6zypLzFIFTBIv2qCJYF2NabkPAkRM/vX1Lf/r3/T19h5lnFkuLjojUcwbrC1F7uwh5ALoJfiZ1CK8miwY84ZnRnmRKl12Rh+8cXdHjUXpFRPzV2KekjtSagINv0vEg8JrQJwDFYhJFnJSWXh9ijueolCFVFxNdFVO0ncVnlLHNVxl5XKffpL+w6Up/tYnSr0+ye0Tx98lQ8U0pc59MSLi2+m5wn56fsvc5WuxGRPuaRz+ZXD33RFcboKfnp+vY3CZUl89f9y4vxcHt5eXj/YO952nakNv5ef85/b6i+s5Kh/g7a3tBh9vA/m3D/W3Q5HbN/37vWHh/mnd+W2BuFscZWtQZukDTiuLGAIM5UKVl73OZ5WELfpAupGKUwlHdlAI8cVi3dXpTjIe9ZiUOWAuLjnIjujzh0mOxQ1Je4daM7CMf5aGxYGYWYHmYBzdDs7Db6bC1f77uVoKLAKQ1OU46b8xZB2/oCGo6+pn1vt1VbQy1h7JkvHn19vfskyCoatUBxLNtBeVVSMvwJvdebbTWWMdERSSxo7MTJrVHCxmdc99SRI7J4pYK0lfYefCVe2FEV6r4zN+R6vfR6IzFAywzApnUIuDQ8xiQ4caasIodlH+j5XXVnIr2IitNHoSOMwOPc2Pbl7lOeLzki8Zf58b6hOVVAfoJNcgwVe1ddJLRndH4gswW6BzMd0D9Ej1IRb1usNWcY6U1N1KE+rtuP4NmH3yI5gcKg25kdrRreVk7Mo5B+POPIPwRhN83CINjPjc0xM5DqxTa/pQP2yI3XMZ3uB4upaipl0J70w6OlVXUhHpfunQ4hFIOdKVUqcBTizPITNFr9V9TDMaw6jb8K0bJEG/KP32Pm6ifCx8iJzzlf/wzCpRRJ9WN6Ga6pmqE1kUiDwdPB4ckYGmcLyDkQjPTnCOIVWu1nshpzo7D+IYoy3WO/T9jeUMDhcSwVCBDPAeOl40uF7xYzx/pqkKmUlDVy43ztGe5nILDN1bVNf0cB3bSS0hHYf6JCb3r34MP65/wLnQxnf8hNJ0JD3FzA1YS3q/Evnfe5MA++8qRYyvEtlvTiy6+FnqjAQ3d90G4y6zwTfik4DWNNjmCQBuYjAtHWYal7xy5UzVIgtXr8NvxiAaqfsJuJGiwvhXOchl3jMwV6rpeofP0nQDW9X/89MFa
sidebar_class_name: "get api-method"
info_path: docs/api/catalog
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read catalog instance (all keys)"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/metadata/{entity}/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieves all catalog metadata keys and values defined for the specified entity.


<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"type":"string","minLength":1},"in":"query","name":"include","required":false,"description":"Add additional metadata information to the response. For example: schemas, tags."},{"schema":{"type":"string","pattern":"^[a-z]+(_[a-z]+)*$","enum":["organization","account","namespace","application","build","asset","scope","release","deployment","user"]},"in":"path","name":"entity","required":true,"description":"Entity name that holds metadata information."},{"schema":{"type":"string","minLength":1,"pattern":"^[0-9]+$"},"in":"path","name":"id","required":true,"description":"Entity ID that holds metadata information."}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing a metadata entry for an entity in the catalog.","content":{"application/json":{"schema":{"title":"Metadata","type":"object","description":"Object representing a metadata entry for an entity in the catalog.","example":{"my_string_property":"hello","my_number_property":41},"properties":{"additional_properties":{"type":"object","properties":{"entity":{"type":"string","pattern":"^[a-z]+(_[a-z]+)*$","description":"Entity name that holds metadata information.","enum":["organization","account","namespace","application","build","asset","scope","release","deployment","user"]},"id":{"type":"string","minLength":1,"pattern":"^[0-9]+$","description":"Entity ID that holds metadata information."},"nrn":{"description":"NRN where the catalog specification is defined.","title":"NRN","type":"string","pattern":"^organization=(\\d+|\\*)+(?::account=(\\d+|\\*))?(?::namespace=(\\d+|\\*))?(?::application=(\\d+|\\*))?(?::(build|scope|release|asset|deployment)=(\\d+|\\*))?$"},"schemas":{"type":"object","description":"References the metadata schemas against which the existing data is validated."},"tags":{"description":"References the metadata schemas against which the existing data is validated.","type":"array","title":"Tags","items":{"type":"object","properties":{"key":{"type":"string","description":"The key of the tag."},"value":{"type":"string","description":"The value of the tag."}},"required":["key","value"],"additionalProperties":false}}},"additionalProperties":false,"required":["entity","id","nrn"]}},"required":["additional_properties"],"additionalProperties":true}}}},"4XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}},"5XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}}}}
>
  
</StatusCodes>