---
id: catalog-instance-single-read
title: "Read catalog instance (single key)"
description: "Retrieves catalog data for a single metadata key on the specified entity."
sidebar_label: "Read catalog instance (single key)"
hide_title: true
hide_table_of_contents: true
api: eJztV1Fv2zYQ/ivEoQ/JqtjJ0D1Mb0GbbRk2tEhdrEDqGmfxLLGhSIWk3LqC/vtwlGxLSbZlSYa91C+2qOPx43ffkZ8bsBU5DMqacwkpZBhQ23yhjA9oMlp4ZXJNqSOUkEDA3EN6CS+7MLENEwddnLiizSHME5DkM6cqzgspXFBwitbkRZ9fSAwoVtYJFP3MkgLG0SvaCGtEKEj4ijK1UiQFmaDCZvLBQAIVOiwpkGMoDfisoBIhbSBsKoIUfHDK5DEwBHIM4OMlHn2dPz9YdN+H3z2DBMjUJW/GuhyN+hpJgAQwy2xtAiRgsCRfYUY8WlVaZduYZa0084HeE0f6zFYc5UgTev4lqdJ2U1JMVHtyMG8TUAymwlD02SGFbmdx7nWtHElIg6vpJoVnMUzwJBEKDKKwWvo9a8qsrCsjvgm0yd/RUirzG5k8FJCejEk6Pvpx/vwZ3A1UyfuCPH/130G8Vce7wW4XvS/kofqSKEz6gmWlKRWZXZPDnBKxYt19tu7KJ2Jda0MOl0qroMhPoJ0n4CmrHVeTdbkkdOROa97E5ZxfO/KVNZ48b/n79+/5a4zm9fITZUE4qhx5VobJBe7BkQlu07WN6VtCqK5V+saaQAKZNYF1lzZD1U4/eV5ixLoKmsn6fU+WNfR6FeH3JUHnkNWpApWMu+XC9e+W1mpCA4MhZQLl5IZDptZ6/FwuxxE27no40guhvXWSPAlBfWmZgnKz6NZaVI5PQq4dFKS1ZRVuFh3YwcsXJy1/EnhxV/1+igKPAEYQyTnrvJA1LyVO35wLJsphxvP8Q2p2xhn5RB5RmECPVHUi8wFD7V9aSYMu6wtwk9pfZrM3opsgMitJKCMjDpNHAuMeuN2ycbpd047TvTPquu5ndfk6VlbkiG8MNJJrQrl127O3TaBb5B+Tvy2sC4ko6hLNEd9NuNTbtXim4DW75BtOW5L3mN8D9SsKqDRfODFXP09Uzq6VjGKTUnEsahFr9iUAq+GJZLA/qy6Htdvyst/IvBPhD99E+E2E/68I48ZCYdk95tEMxZs4hen2VJ423UncThsl22mzHW/ZOJFbb41c7TQfviFUPp1OsVITvjoqjYF9wySz5eiSfcty7BQ2vGp35HKiaM04jG+rGMTmLf7o6IEUfv1jFtljezIUd+9xIQFG2HF6PDmZHHMtK+tDibEtesdxQSh39vZuX3yjQs2+4Z7YIfcMsDCmlUYVVR3pbfrqXA4dUrrzoGk0eenu3TyBwvrA8U2zRE/vnG5bHr6uybHPmSewRqdY+rGIUnn+LSFdofY37dZwywcXvc4Oxb8yt3+xva1fMbyPNeqanyCBK9rsXTZbjMcgvI+zfRA+JR+N7fEW9kHId1pp+Q9OQSjJRSV0r0+zjKowmHjrZuGe3p0gP5/N+G/VuJNvdO7Ino5ANU0XMbNXZNp2hzHwMwNs2z8Blbs46Q==
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 (single key)"}
>
</Heading>

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



Retrieves catalog data for a single metadata key on the specified entity.


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

<ParamsDetails
  parameters={[{"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."},{"schema":{"type":"string","minLength":1,"pattern":"^[a-z]+(_[a-z]+)*$"},"in":"path","name":"metadata","required":true,"description":"Entity metadata key, for example: coverage, frameworks, vulnerabilities."}]}
>
  
</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","oneOf":[{"type":"array","items":{}},{"type":"boolean"},{"type":"integer"},{"type":"null"},{"type":"number"},{"type":"object"},{"type":"string"}],"description":"Object representing a metadata entry for an entity in the catalog.","example":{"my_string_property":"hello","my_number_property":41}}}}},"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>