# List permission groups

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/setting/group
```

- API version: v1
- Operation ID: `v1_public_group_index`
- Section: Team settings › [Permission groups](https://developer.yoprint.com/reference/permission-groups.md)
- Web page: https://developer.yoprint.com/reference/permission-groups/v1-group-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns all the team's permission groups in one list, with their permissions.

Permission groups decide what members can do. Each member belongs to one group; the team owner can do everything. Teams start with groups such as Super Admin, Shop Manager, Sales Team, Shop Floor Team and Accounting Team. Creating, changing and deleting groups needs a plan with advanced permission management; moving a member to another group doesn't.

## Permission

Any team member can call it. Reading needs no extra permission.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/group' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `id` (string, required)
    - `name` (string, required)
    - `permissions` (array of strings, required): Permission keys. `manage_setting` is Manage Settings, `manage_billing` Manage Billing, `manage_stock` Manage Stock. For orders, quotes, purchase orders and customers, `*_all_*` covers every record and `*_self_*` (or `*_assigned_*`) only records assigned to the member. `view_order_finance` is View Sales Order Pricing; `view_customer_finance` is View Customer Sales Aggregates. Listed as saved, repeats included. One of: `"manage_setting"`, `"manage_stock"`, `"manage_billing"`, `"view_production_board"`, `"create_product"`, `"update_product"`, `"view_product"`, `"create_service"`, `"update_service"`, `"view_service"`, `"create_order"`, `"view_all_order"`, `"view_self_order"`, `"update_all_order"`, `"update_self_order"`, `"message_all_order"`, `"message_self_order"`, `"create_quote"`, `"view_all_quote"`, `"view_self_quote"`, `"update_all_quote"`, `"update_self_quote"`, `"create_po"`, `"view_all_po"`, `"view_self_po"`, `"update_all_po"`, `"update_self_po"`, `"view_all_customer"`, `"view_assigned_customer"`, `"update_assigned_customer"`, `"update_all_customer"`, `"create_customer"`, `"view_vendor"`, `"update_vendor"`, `"create_vendor"`, `"view_report"`, `"view_customer_finance"`, `"view_order_finance"`.
    - `users` (array of objects, required): The members in the group.
      - Each item:
        - `avatar_url` (string | null, required)
        - `email` (string, required)
        - `id` (string, required): The member's id, as List team members gives it.
        - `name` (string, required)
    - `version` (integer, required): The permission format. 3 for every group created or updated through the API.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "id": "aaNZmyj0mvmWLU",
      "name": "Sales Team",
      "permissions": [
        "create_order",
        "view_all_order",
        "update_all_order",
        "create_customer",
        "view_all_customer"
      ],
      "users": [
        {
          "avatar_url": null,
          "email": "alex@example.com",
          "id": "ZiGXY6Fzqgi3AM",
          "name": "Alex Rivera"
        }
      ],
      "version": 3
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Related

- [Move a member to a permission group](https://developer.yoprint.com/reference/permission-groups/v1-group-change-user-group.md): `PATCH /v1/api/store/{team_slug}/setting/group/{id}/change_user_group`
- [List team members](https://developer.yoprint.com/reference/team-members/v1-user-index.md): `GET /v1/api/store/{team_slug}/setting/user`