Dropbox: Retrieves information about one or more groups
Dropbox team.groupsGetInfo: arguments, response, policy and SDK examples.
← Team operations · Get started
Operation dropbox.team_groups_get_info
Provider route: POST /2/team/groups/get_info. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DropboxIntegration } from "@alter-ai/dropbox";
async function execute(input: Parameters<DropboxIntegration["team"]["groupsGetInfo"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.team.groupsGetInfo(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_dropbox import DropboxIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.team.groups_get_info(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Dropbox-API-Path-Root | Model | Optional | Expand Deletes a group — request body — headers Dropbox-API-Path-Root |
headers.Dropbox-API-Select-User | string | Optional | |
headers.Dropbox-API-Select-Admin | string | Optional | |
body | Model | Required within parent | Expand Retrieves information about one or more groups — request body — body |
Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Retrieves information about one or more groups — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieves information about one or more groups — response body |
Referenced models: Retrieves information about one or more groups — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Deletes a group — request body — headers Dropbox-API-Path-Root
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: home |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: home |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: root |
$ (anyOf 3).root | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: namespace_id |
$ (anyOf 4).namespace_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:home|root|namespace_id)$) |
Retrieves information about one or more groups — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand Retrieves information about one or more groups — response body — item |
Referenced models: Retrieves information about one or more groups — response body — item
Retrieves information about one or more groups — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Argument for selecting a list of groups, either by group_ids, or external group IDs. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: group_ids |
$ (anyOf 1).group_ids | array | Required within parent | |
$ (anyOf 1).group_ids[] | string | Each item | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: group_external_ids |
$ (anyOf 2).group_external_ids | array | Required within parent | |
$ (anyOf 2).group_external_ids[] | string | Each item |
Retrieves information about one or more groups — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: id_not_found |
$ (anyOf 1).id_not_found | string | Required within parent | |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: group_info |
$ (anyOf 2).group_name | string | Required within parent | |
$ (anyOf 2).group_id | string | Required within parent | |
$ (anyOf 2).group_external_id | JSON | Optional | |
$ (anyOf 2).group_external_id (anyOf 1) | string | Alternative | |
$ (anyOf 2).group_external_id (anyOf 2) | null | Alternative | |
$ (anyOf 2).member_count | JSON | Optional | |
$ (anyOf 2).member_count (anyOf 1) | JSON | Alternative | |
$ (anyOf 2).member_count (anyOf 1) (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).member_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).member_count (anyOf 2) | null | Alternative | |
$ (anyOf 2).group_management_type | Model | Required within parent | Expand Updates a group's name and or external ID — response body — group management type |
$ (anyOf 2).members | JSON | Optional | |
$ (anyOf 2).members (anyOf 1) | array | Alternative | |
$ (anyOf 2).members (anyOf 1)[] | Model | Each item | Expand Lists members of a group — response body — members item |
$ (anyOf 2).members (anyOf 2) | null | Alternative | |
$ (anyOf 2).created | JSON | Required within parent | |
$ (anyOf 2).created (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 2).created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Updates a group's name and or external ID — response body — group management type, Lists members of a group — response body — members item
Updates a group's name and or external ID — response body — group management type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The group type determines how a group is managed. |
$ (anyOf 1) | string | Alternative | Known values: user_managed, company_managed, system_managed |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: user_managed |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: company_managed |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: system_managed |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:user_managed|company_managed|system_managed)$) |
Lists members of a group — response body — members item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Profile of group member, and role in group. |
profile | Model | Required within parent | Expand List member space limits excluded users — response body — users item |
access_type | Model | Required within parent | Expand Lists members of a group — response body — members item access type |
Referenced models: Lists members of a group — response body — members item access type, List member space limits excluded users — response body — users item
Lists members of a group — response body — members item access type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Role of a user in group. |
$ (anyOf 1) | string | Alternative | Known values: member, owner |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: member |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: owner |
Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Required within parent | Maximum length: 255 Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$ |
is_verified | boolean | Required within parent |
Updates a team member's profile — team members Set Profile — response body — profile status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The user's status as a member of a specific team. |
$ (anyOf 1) | string | Alternative | Known values: active, invited, suspended |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: active |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: invited |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: suspended |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: removed |
$ (anyOf 5).is_recoverable | boolean | Required within parent | |
$ (anyOf 5).is_disconnected | boolean | Required within parent |
Updates a team member's profile — team members Set Profile — response body — profile membership type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: full, limited |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: full |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: limited |
Get information about a user's account — response body — name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Representations for a person's name to assist with internationalization. |
given_name | string | Required within parent | |
surname | string | Required within parent | |
familiar_name | string | Required within parent | |
display_name | string | Required within parent | |
abbreviated_name | string | Required within parent |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: dropbox.team_groups_get_info. Catalog operation: team/groups_get_info. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["groups.read"]