Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Groups

Add Group

Endpoint to add a new Group.

post/business/v2/groups

Request body

namestring

The name of the Group.

custom_reference_idstring

The Group reference in an external system.

notestring

Any notes about the Group.

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

Example request

{
  "name": "HR",
  "custom_reference_id": "hr-division-0001",
  "note": "division"
}

Response

The returned resource is a single Group.

idstring

The Group ID (sortable: yes).

namestring

The name of the Group (sortable: yes).

custom_reference_idstring

The Group reference in an external system.

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

Any notes about the Group (sortable: no).

membersstring[]

A list of User IDs belonging to the Group (sortable: no).

walletsstring[]

A list of Wallet IDs related to the Group (sortable: no).

cardsstring[]

A list of Card IDs related to the Group (sortable: no).

creation_timestring

The date and time when the Group was created (sortable: yes).

last_updatestring

The date and time when the Group was last updated (sortable: yes).

Example response

{
  "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"
}