---
title: "View group details by name"
method: GET
path: "/v1/groups?name={group_name}"
---

# View group details by name

`GET /v1/groups?name={group_name}`

## Request

- Base URL: `https://api.gomotive.com`
- URL: `https://api.gomotive.com/v1/groups?name={group_name}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/gomotive/apis/motive/docs/v1/groups%3Fname=:group_name/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `name` string, required

## Headers

- `X-API-KEY` string, required

## Response `200`

200

- object
  - `groups` object[]
    - `group` object
      - `id` integer
      - `name` string
      - `company_id` integer
      - `parent_id` integer
      - `user` object
        - `id` integer
        - `first_name` string
        - `last_name` string
        - `username` unknown
        - `email` string
        - `driver_company_id` unknown
        - `status` string
        - `role` string
  - `pagination` object
    - `per_page` integer
    - `page_no` integer
    - `total` integer

---

[API](https://skmtc.dev/gomotive/apis/motive.md) - [All operations](https://skmtc.dev/gomotive/apis/motive/llms.txt) - [OpenAPI document](https://skmtc.dev/gomotive/apis/motive/revisions/c71780e497f5?raw)