---
title: "Search Groups"
method: GET
path: "/business/v2/groups"
tags: ["Groups"]
---

# Search Groups

`GET /business/v2/groups`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/groups`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `group_read`
- TypeScript: <https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/docs/business/v2/groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to search `Groups`

## Query parameters

- `customReferenceId` string: The `Group` reference in an external system.
- `type` 'TEAM' | 'PROJECT' | 'DEPARTMENT' | 'DIVISION' | 'SQUAD' | 'UNIT' | 'PRODUCTION'
- `name` string: The name of the `Group`.
- `note` string: The note of the `Group`.
- `text` string: A text contained in the name or note of the `Group`.
- `p` integer: It indicates the specific page to display (the counter starts from zero).
- `s` integer: It indicates the number of items per page.
- `d` 'ASC' | 'DESC': It indicates how the pages are ordered.
- `props` string[]: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.

## Response `200`

The result is an array containing `Group`.

- Groups
  - `total` integer: It represents the total number of available items in the list.
  - `pages` integer: It represents the total number of available pages.
  - `page_size` integer: It represents the number of items per page.
  - `current_page` integer: It indicates the current page (the counter starts from zero).
  - `results_size` integer: It indicates the size of the array results.
  - `results` Group[]
    - `id` string: The `Group` ID (sortable: yes).
    - `name` string: The name of the `Group` (sortable: yes).
    - `custom_reference_id` string: The `Group` reference in an external system.
    - `type` 'TEAM' | 'PROJECT' | 'DEPARTMENT' | 'DIVISION' | 'SQUAD' | 'UNIT' | 'PRODUCTION'
    - `note` string: Any notes about the `Group` (sortable: no).
    - `members` string[]: A list of `User` IDs belonging to the `Group` (sortable: no).
    - `wallets` string[]: A list of `Wallet` IDs related to the `Group` (sortable: no).
    - `cards` string[]: A list of `Card` IDs related to the `Group` (sortable: no).
    - `creation_time` string: The date and time when the `Group` was created (sortable: yes).
    - `last_update` string: The date and time when the `Group` was last updated (sortable: yes).

## Other responses

- `400`: Your request has missing arguments or is malformed.

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)