Some connections come with additional parameters and parameter values. These are entry points into different sub-accounts or projects within the integration.
For example, ads systems like Google Ads and Facebook Ads contain multiple accounts, where each account is a separate workspace of ads data. Similarly, a GitHub connection has its data split into multiple repositories, where each repository is a separate data container of commits, pull requests, and so on.
This endpoint lets you check for and retrieve the parameter names and their values. In the case of ad systems it will return the parameter name accounts
and a list of account IDs, while in the case of GitHub it will return the parameter name repos
and a list of repositories.
Here's an example payload returned from a Google Ads connection:
{
data:
{
"accounts": [
{
"value": "customer.6618989486",
"label": "USA Google Ads Account (661-898-9486)"
},
{
"value": "customer.124769121",
"label": "Canada Ads Account (124-769-1210"
},
...
]
}
}
This data can be used when updating a connection to restrict the selection to specific parameter values (using the example above, specific Google Ad accounts).