Skip to content

Get group

GET
/v2/document/group/{id}

Get all the details of a group by ID

id
required
string
groupId
required
string

A group Id

Example
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
X-API-Key
string

API Key

X-API-Secret
string

API Secret

Retrieves the details of a single group

object
id

A group Id

string
name

A group name

string
description

A group description

string
organisationId

An organisation Id

string
status

The status of the group

string
Allowed values: INPROGRESS TODO COMPLETE ARCHIVED
INPROGRESS
priority

The priority of the group

string
Allowed values: LOW MEDIUM HIGH EMPTY
LOW
tags

A tag array

Array<object>
object
id
required

Unique ID for the tag

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
name
required

A unique name for your tag

string
Review
description

A description for your tag

string
Groups with this tag need to be reviewed
color
required

A color for your tag

string
Allowed values: Blue Pink Purple Orange
Blue
status

A tag status

string
Active