--- title: List org groups description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Org Groups --- # List org groups{% #list-org-groups %} {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | --------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/org_groups | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/org_groups | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/org_groups | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/org_groups | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/org_groups | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/org_groups | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/org_groups | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/org_groups | ### Overview List all organization groups that the requesting organization has access to. This endpoint requires the `org_group_read` permission. ### Arguments #### Query Strings | Name | Type | Description | | ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | page[number] | integer | The page number to return. | | page[size] | integer | The number of items per page. Maximum is 1000. | | sort | enum | Field to sort org groups by. Supported values: `name`, `uuid`, `-name`, `-uuid`. Defaults to `uuid`. Allowed enum values: `name, -name, uuid, -uuid` | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a list of org groups. | Parent field | Field | Type | Description | | ------------ | -------------------------------- | --------- | ---------------------------------------------------------------------------- | | | data [*required*] | [object] | An array of org groups. | | data | attributes [*required*] | object | Attributes of an org group. | | attributes | created_at [*required*] | date-time | Timestamp when the org group was created. | | attributes | modified_at [*required*] | date-time | Timestamp when the org group was last modified. | | attributes | name [*required*] | string | The name of the org group. | | attributes | owner_org_site [*required*] | string | The site of the organization that owns this org group. | | attributes | owner_org_uuid [*required*] | uuid | The UUID of the organization that owns this org group. | | data | id [*required*] | uuid | The ID of the org group. | | data | type [*required*] | enum | Org groups resource type. Allowed enum values: `org_groups` | | | links | object | Pagination links for navigating between pages of an org group list response. | | links | first | string | Link to the first page. | | links | last | string | Link to the last page. | | links | next | string | Link to the next page. | | links | prev | string | Link to the previous page. | | links | self | string | Link to the current page. | | | meta | object | Pagination metadata for org group list responses. | | meta | page | object | Page-based pagination details for org group list responses. | | page | first_number | int64 | First page number. | | page | last_number | int64 | Last page number. | | page | next_number | int64 | Next page number. | | page | number | int64 | Page number. | | page | prev_number | int64 | Previous page number. | | page | size | int64 | Page size. | | page | total | int64 | Total number of results. | | page | type | string | Pagination type. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "created_at": "2024-01-15T10:30:00Z", "modified_at": "2024-01-15T10:30:00Z", "name": "My Org Group", "owner_org_site": "us1", "owner_org_uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890" }, "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789", "type": "org_groups" } ], "links": { "first": "string", "last": "string", "next": "string", "prev": "string", "self": "string" }, "meta": { "page": { "first_number": "integer", "last_number": "integer", "next_number": "integer", "number": "integer", "prev_number": "integer", "size": "integer", "total": "integer", "type": "number_size" } } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "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/org_groups" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List org groups returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.org_groups_api import OrgGroupsApi configuration = Configuration() configuration.unstable_operations["list_org_groups"] = True with ApiClient(configuration) as api_client: api_instance = OrgGroupsApi(api_client) response = api_instance.list_org_groups() 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 # List org groups returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.list_org_groups".to_sym] = true end api_instance = DatadogAPIClient::V2::OrgGroupsAPI.new p api_instance.list_org_groups() ``` #### 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 // List org groups 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() configuration.SetUnstableOperationEnabled("v2.ListOrgGroups", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewOrgGroupsApi(apiClient) resp, r, err := api.ListOrgGroups(ctx, *datadogV2.NewListOrgGroupsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OrgGroupsApi.ListOrgGroups`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OrgGroupsApi.ListOrgGroups`:\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 // List org groups returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.OrgGroupsApi; import com.datadog.api.client.v2.model.OrgGroupListResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.listOrgGroups", true); OrgGroupsApi apiInstance = new OrgGroupsApi(defaultClient); try { OrgGroupListResponse result = apiInstance.listOrgGroups(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OrgGroupsApi#listOrgGroups"); 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 // List org groups returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_org_groups::ListOrgGroupsOptionalParams; use datadog_api_client::datadogV2::api_org_groups::OrgGroupsAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.ListOrgGroups", true); let api = OrgGroupsAPI::with_config(configuration); let resp = api .list_org_groups(ListOrgGroupsOptionalParams::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 /** * List org groups returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.listOrgGroups"] = true; const apiInstance = new v2.OrgGroupsApi(configuration); apiInstance .listOrgGroups() .then((data: v2.OrgGroupListResponse) => { 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 %}