--- title: Get team sync configurations description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Teams --- # Get team sync configurations{% #get-team-sync-configurations %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/team/sync | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/team/sync | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/team/sync | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/team/sync | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/team/sync | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/team/sync | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/team/sync | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/team/sync | ### Overview Get all team synchronization configurations. Returns a list of configurations used for linking or provisioning teams with external sources like GitHub. This endpoint requires the `teams_read` permission. OAuth apps require the `teams_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#teams) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | -------------------------------- | ---- | --------------------------------------------------------------------------------------------- | | filter[source] [*required*] | enum | Filter by the external source platform for team synchronization Allowed enum values: `github` | ### Response {% tab title="200" %} OK {% tab title="Model" %} Team sync configurations response. | Parent field | Field | Type | Description | | --------------- | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data | [object] | List of team sync configurations | | data | attributes [*required*] | object | Team sync attributes. | | attributes | frequency | enum | How often the sync process should be run. Defaults to `once` when not provided. Allowed enum values: `once,continuously,paused` | | attributes | selection_state | [object] | Specifies which teams or organizations to sync. When provided, synchronization is limited to the specified items and their subtrees. | | selection_state | external_id [*required*] | object | The external identifier for a team or organization in the source platform. | | external_id | type [*required*] | enum | The type of external identifier for the selection state item. For GitHub synchronization, the allowed values are `team` and `organization`. Allowed enum values: `team,organization` | | external_id | value [*required*] | string | The external identifier value from the source platform. For GitHub, this is the string representation of a GitHub organization ID or team ID. | | selection_state | operation | enum | The operation to perform on the selected hierarchy. When set to `include`, synchronization covers the referenced teams or organizations. Allowed enum values: `include` | | selection_state | scope | enum | The scope of the selection. When set to `subtree`, synchronization includes the referenced team or organization and everything nested under it. Allowed enum values: `subtree` | | attributes | source [*required*] | enum | The external source platform for team synchronization. Only "github" is supported. Allowed enum values: `github` | | attributes | sync_membership | boolean | Whether to sync members from the external team to the Datadog team. Defaults to `false` when not provided. | | attributes | type [*required*] | enum | The type of synchronization operation. "link" connects teams by matching names. "provision" creates new teams when no match is found. Allowed enum values: `link,provision` | | data | id | string | The sync's identifier | | data | type [*required*] | enum | Team sync bulk type. Allowed enum values: `team_sync_bulk` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "frequency": "once", "selection_state": [ { "external_id": { "type": "team", "value": "1" }, "operation": "include", "scope": "subtree" } ], "source": "github", "sync_membership": true, "type": "link" }, "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "type": "team_sync_bulk" } ] } ``` {% /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 ##### \# Required query arguments export filter[source]="github" \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/team/sync?filter[source]=${filter[source]}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get team sync configurations returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.teams_api import TeamsApi from datadog_api_client.v2.model.team_sync_attributes_source import TeamSyncAttributesSource configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = TeamsApi(api_client) response = api_instance.get_team_sync( filter_source=TeamSyncAttributesSource.GITHUB, ) 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 team sync configurations returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::TeamsAPI.new p api_instance.get_team_sync(TeamSyncAttributesSource::GITHUB) ``` #### 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 team sync configurations 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.NewTeamsApi(apiClient) resp, r, err := api.GetTeamSync(ctx, datadogV2.TEAMSYNCATTRIBUTESSOURCE_GITHUB) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TeamsApi.GetTeamSync`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `TeamsApi.GetTeamSync`:\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 team sync configurations returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.TeamsApi; import com.datadog.api.client.v2.model.TeamSyncAttributesSource; import com.datadog.api.client.v2.model.TeamSyncResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); TeamsApi apiInstance = new TeamsApi(defaultClient); try { TeamSyncResponse result = apiInstance.getTeamSync(TeamSyncAttributesSource.GITHUB); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TeamsApi#getTeamSync"); 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 team sync configurations returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_teams::TeamsAPI; use datadog_api_client::datadogV2::model::TeamSyncAttributesSource; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = TeamsAPI::with_config(configuration); let resp = api.get_team_sync(TeamSyncAttributesSource::GITHUB).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 team sync configurations returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.TeamsApi(configuration); const params: v2.TeamsApiGetTeamSyncRequest = { filterSource: "github", }; apiInstance .getTeamSync(params) .then((data: v2.TeamSyncResponse) => { 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 %}