Get groups
GET /v2/document/group
GET
/v2/document/group
List of groups.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” page[number]
number
Page number (starts at 1)
Example
1
page[size]
number
Items per page
Example
10
Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Responses
Section titled “ Responses ”List of groups
object
groups
required
List of groups
Array<object>
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
INPROGRESS
priority
The priority of the group
string
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
Blue
status
A tag status
string
Active
page
required
List of groups
object
number
required
The current page number.
number
1
size
required
The number of items per page.
number
10
totalPages
required
The total number of pages available.
number
100
totalCount
required
The total number of items available.
number
1000
hasNext
required
Indicates whether there is a next page available.
boolean
true
hasPrev
required
Indicates whether there is a previous page available.
boolean
true