Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Groups

Search Groups

Endpoint to search Groups

get/business/v2/groups

Query parameters

customReferenceIdstring

The Group reference in an external system.

Example:hr-division-0001

The Group reference in an external system.

type'TEAM' | 'PROJECT' | 'DEPARTMENT' | 'DIVISION' | 'SQUAD' | 'UNIT' | 'PRODUCTION'

The Group's type.

namestring

The name of the Group.

Example:HR

The name of the Group.

notestring

The note of the Group.

Example:division

The note of the Group.

textstring

A text contained in the name or note of the Group.

Example:HR

A text contained in the name or note of the Group.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

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.

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.

[
  "creationTime"
]

Response

The result is an array containing Group.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "1bf79328-a7ae-4222-aa54-091ff7f429a7",
      "name": "HR",
      "custom_reference_id": "hr-division-0001",
      "note": "division",
      "members": [
        "5bf79328-a7ae-4222-aa54-091ff7f429a7"
      ],
      "wallets": [
        "4bf79328-a7ae-4222-aa54-091ff7f429a7"
      ],
      "cards": [
        "3bf79328-a7ae-4222-aa54-091ff7f429a7"
      ],
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update": "2017-06-30T12:48:40Z"
    }
  ]
}