---
title: "List the G Suite instances bound to a User"
method: GET
path: "/api/v2/users/{user_id}/gsuites"
tags: ["Graph", "Users"]
---

# List the G Suite instances bound to a User

`GET /api/v2/users/{user_id}/gsuites`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/users/{user_id}/gsuites`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/users/:user_id/gsuites/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint will return all G-Suite Instances bound to a User, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization.

Each element will contain the type, id, attributes and paths.

The `attributes` object is a key/value hash of compiled graph attributes for all paths followed.

The `paths` array enumerates each path from this User to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User.

See `/members` and `/associations` endpoints to manage those collections.

#### Sample Request
```
curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/gsuites \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

## Query parameters

- `limit` integer
- `skip` integer
- `filter` string[]

## Headers

- `x-org-id` string

## Response `200`

OK

- GraphObjectWithPaths[]
  - `compiledAttributes` GraphAttributes, nullable: The graph attributes.
  - `id` string, required: Object ID of this graph object.
  - `paths` array[], required: Every path through the graph from the requested object to this object. Each path lists the groupings and associations it follows; all of them would have to be removed to remove this object from the requested object.
    - GraphConnection[]
      - `attributes` GraphAttributes, nullable: The graph attributes.
      - `from` GraphObject
        - `attributes` GraphAttributes, nullable: The graph attributes.
        - `id` string, required: The ObjectID of the graph object.
        - `type` string, required: The type of graph object.
      - `to` GraphObject, required
        - `attributes` GraphAttributes, nullable: The graph attributes.
        - `id` string, required: The ObjectID of the graph object.
        - `type` string, required: The type of graph object.
  - `type` 'active_directory' | 'agent' | 'agent_group' | 'application' | 'command' | 'g_suite' | 'idp_routing_policy' | 'ldap_server' | 'office_365' | 'policy' | 'policy_group' | 'radius_server' | 'password_manager_item' | 'system' | 'system_group' | 'user' | 'user_group', required: A graph object type.
  - `externalId` string: The external resource ID that is being synced. Only present when syncStatus query parameter is true.
  - `syncStatus` SyncStatus: Sync status information for this object. Only present when syncStatus query parameter is true.
    - `syncedAt` string, date-time: The last time the object was synced.
    - `code` integer: Status code of the sync operation.
    - `message` string: Status message of the sync operation.
    - `details` object[]: Additional details about the sync status.

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)