Get Group List

GET

https://api.staple.io/v1/groups/list

GET

/v1/groups/list

$ curl https://api.staple.io/v1/groups/list \
>      -H "x-api-key: <apiKey>"

200Get Group List

1 {
2   "getGroupsList": [
3     {
4       "createdAt": 1577369282259,
5       "id": 1,
6       "name": "Initial reports",
7       "queueCount": 5,
8       "queues": [
9         {
10           "accountType": "",
11           "createdAt": 1578641364665,
12           "customer": "czxczxczxc",
13           "docType": "INVOICE",
14           "documentCount": 182,
15           "gid": 3,
16           "id": 14,
17           "language": "en",
18           "name": "Company account for stationary",
19           "supplier": "czxczxc",
20           "tags": "",
21           "uid": 20
22         },
23         {
24           "accountType": "",
25           "createdAt": 1578641372516,
26           "customer": "czxczxczxc",
27           "docType": "INVOICE",
28           "documentCount": 40,
29           "gid": 3,
30           "id": 15,
31           "language": "en",
32           "name": "expenses",
33           "supplier": "czxczxc",
34           "tags": "",
35           "uid": 20
36         },
37         {
38           "accountType": "",
39           "createdAt": 1578720955737,
40           "customer": "",
41           "docType": "RECEIPT",
42           "documentCount": 25,
43           "gid": 3,
44           "id": 30,
45           "language": "en",
46           "name": "Test Q 12",
47           "supplier": "",
48           "tags": "",
49           "uid": 20
50         },
51         {
52           "accountType": "",
53           "createdAt": 1584529233813,
54           "customer": "",
55           "docType": "INVOICE",
56           "documentCount": 4,
57           "gid": 3,
58           "id": 69,
59           "language": "en",
60           "name": "synchronous",
61           "supplier": "",
62           "tags": "",
63           "uid": 20
64         },
65         {
66           "accountType": "",
67           "createdAt": 1586010434014,
68           "customer": "test",
69           "docType": "MRC",
70           "documentCount": 3,
71           "gid": 3,
72           "id": 118,
73           "language": "en",
74           "name": "test2",
75           "supplier": "test",
76           "tags": "",
77           "uid": 20
78         }
79       ],
80       "uid": 1
81     },
82     {
83       "createdAt": 1578368846424,
84       "id": 2,
85       "name": "Luc Group",
86       "queueCount": 2,
87       "queues": [
88         {
89           "accountType": "",
90           "createdAt": 1588734595763,
91           "customer": "",
92           "docType": "RECEIPT",
93           "documentCount": 3,
94           "gid": 8,
95           "id": 258,
96           "language": "multi",
97           "name": "Test Q 01",
98           "supplier": "",
99           "tags": "",
100           "uid": 20
101         },
102         {
103           "accountType": "",
104           "createdAt": 1591542331283,
105           "customer": "",
106           "docType": "INVOICE",
107           "documentCount": 7,
108           "gid": 8,
109           "id": 276,
110           "language": "en",
111           "name": "Test Q 001",
112           "supplier": "",
113           "tags": "",
114           "uid": 20
115         }
116       ],
117       "uid": 20
118     }
119   ]
120 }

Get the list of all your groups, their details and the queues that exist in each of the groups.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Authentication

Response