--- title: Get a list of entity kinds description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Software Catalog --- # Get a list of entity kinds{% #get-a-list-of-entity-kinds %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/catalog/kind | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/catalog/kind | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/catalog/kind | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/catalog/kind | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/catalog/kind | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/catalog/kind | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/catalog/kind | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/catalog/kind | ### Overview Get a list of entity kinds from Software Catalog. OAuth apps require the `apm_service_catalog_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#software-catalog) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | ------------ | ------- | ------------------------------------------------------------- | | page[offset] | integer | Specific offset to use as the beginning of the returned page. | | page[limit] | integer | Maximum number of kinds in the response. | | filter[id] | string | Filter entities by UUID. | | filter[name] | string | Filter entities by name. | ### Response {% tab title="200" %} OK {% tab title="Model" %} List kind response. | Parent field | Field | Type | Description | | ------------ | ----------- | -------- | ------------------------------------------------------------------------------------------------------------- | | | data | [object] | List of kind responses. | | data | attributes | object | Kind attributes. | | attributes | description | string | Short description of the kind. | | attributes | displayName | string | User friendly name of the kind. | | attributes | name | string | The kind name. | | data | id | string | A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. | | data | meta | object | Kind metadata. | | meta | createdAt | string | The creation time. | | meta | modifiedAt | string | The modification time. | | data | type | string | Kind. | | | meta | object | Kind response metadata. | | meta | count | int64 | Total kinds count. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "description": "string", "displayName": "string", "name": "my-job" }, "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "meta": { "createdAt": "string", "modifiedAt": "string" }, "type": "string" } ], "meta": { "count": "integer" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/catalog/kind" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a list of entity kinds returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SoftwareCatalogApi(api_client) response = api_instance.list_catalog_kind() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get a list of entity kinds returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::SoftwareCatalogAPI.new p api_instance.list_catalog_kind() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get a list of entity kinds returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewSoftwareCatalogApi(apiClient) resp, r, err := api.ListCatalogKind(ctx, *datadogV2.NewListCatalogKindOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SoftwareCatalogApi.ListCatalogKind`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SoftwareCatalogApi.ListCatalogKind`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get a list of entity kinds returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.SoftwareCatalogApi; import com.datadog.api.client.v2.model.ListKindCatalogResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient); try { ListKindCatalogResponse result = apiInstance.listCatalogKind(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SoftwareCatalogApi#listCatalogKind"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get a list of entity kinds returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_software_catalog::ListCatalogKindOptionalParams; use datadog_api_client::datadogV2::api_software_catalog::SoftwareCatalogAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SoftwareCatalogAPI::with_config(configuration); let resp = api .list_catalog_kind(ListCatalogKindOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a list of entity kinds returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.SoftwareCatalogApi(configuration); apiInstance .listCatalogKind() .then((data: v2.ListKindCatalogResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}