---
title: "Get group by id"
method: GET
path: "/groups/{id}"
tags: ["Groups"]
---

# Get group by id

`GET /groups/{id}`

## Request

- Base URL: `https://localhost:8446/api/v2`
- URL: `https://localhost:8446/api/v2/groups/{id}`
- Auth: API key in header `Authorization`

Returns group info.

## Path parameters

- `id` number, required

## Response `200`

Successful response

- object
  - `id` number, required: Group id
  - `name` string, required: Group name
  - `description` string, required: Group description
  - `type` string, required: Group type
  - `access` string, required: Group access
  - `agents` object, required: Group agents
  - `agents.id` number, required: Agent id
  - `jobs` object, required: Group jobs NOTE: Specifying jobs in the group route is deprecated since 4.2.0. Use the update job route for this purpose.
  - `jobs.id` number, required: Job id
  - `jobs.permission` string, required: Job permissions
  - `jobs.path` object, required: Job path
  - `jobs.path.macro` string: Macro. If the parameter is not specified, custom path is used
  - `jobs.path.linux` string, required: Linux path
  - `jobs.path.linux_cache` string, required: Linux cache path. Only for caching_gateway role
  - `jobs.path.win` string, required: Windows path
  - `jobs.path.osx` string, required: OS X path
  - `jobs.path.android` string, required: Android path
  - `jobs.path.xbox` string, required: Xbox path
  - `jobs.role` string, required: Role
  - `jobs.file_policy_id` number, required: File policy id. Only for caching_gateway, enduser role
  - `jobs.priority_agents` boolean: Priority agents. Only for agent with primary_storage role or agent in sync job.
  - `jobs.lock_server` boolean: Locks server. Is only present if group is lock server in sync, file_caching or hybrid_work job. Only for the case when setting.use_file_locking is true for group with primary_storage role or group in sync job. Can not be changed via group API. To change the value use the update job route.
  - `autoadd_new_agents` boolean, required: Deprecated, use auto_group_type instead. Automatically add new agents.
  - `auto_group_type` string, required: Auto group type
  - `match` object, required: Match agents by tag
  - `match.tag_name` string, required: Client's tag name
  - `match.tag_value` string, required: Client's tag value to match, regular expression
  - `profile_id` number: Agent Profile id
  - `peer_id` string: Group peer id (in case high_availability or gateway_scale_out type is selected)
  - `schedule_id` number: Bandwidth schedule id

## Other responses

- `default`: Error response. Depending on the error, either a 4xx or 5xx response status is returned.

---

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