Get all groups

GET

/groups

GET

/groups

$ curl https://api.getpostman.com/groups \
>      -H "x-api-key: <apiKey>"

1 {
2   "data": [
3     {
4       "id": 123,
5       "teamId": 1,
6       "name": "API Test Group",
7       "summary": "API testing group.",
8       "createdBy": 12345678,
9       "createdAt": "2024-10-03T14:05:05.000Z",
10       "updatedAt": "2024-10-03T14:05:05.000Z",
11       "members": [
12         12345678,
13         87654321,
14         56781234
15       ],
16       "roles": [
17         "user"
18       ]
19     },
20     {
21       "id": 456,
22       "teamId": 1,
23       "name": "Billing",
24       "summary": "",
25       "createdBy": 12345678,
26       "createdAt": "2024-03-06T11:01:42.000Z",
27       "updatedAt": "2024-04-04T13:36:11.000Z",
28       "members": [
29         56789012
30       ],
31       "roles": [
32         "user"
33       ]
34     },
35     {
36       "id": 789,
37       "teamId": 1,
38       "name": "Collaboration",
39       "summary": "",
40       "createdBy": 12345678,
41       "createdAt": "2024-03-15T19:44:20.000Z",
42       "updatedAt": "2024-03-15T19:44:20.000Z",
43       "members": [
44         12345678,
45         87654321,
46         56781234,
47         78906531,
48         45507812
49       ],
50       "roles": [
51         "user"
52       ]
53     }
54   ]
55 }

Gets all of a team’s Postman groups.

Gets all of a team's Postman [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

Successful Response

datalist of objects

A list of Postman groups.

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error