List Groups

GET

Lists the available groups.

Query parameters

created_bylist of stringsOptional

Filters the groups on the basis of creator.

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

group_typelist of enumsOptional

Filters the groups based on the group type.

Allowed values: dynamicstatic

ingestion_sourcelist of enumsOptional

Filter groups by ingestion source(s).

Allowed values: airdropscim

is_defaultbooleanOptional

Whether to fetch default or custom groups.

limitintegerOptional

The maximum number of groups to return. The default is ‘50’.

member_typelist of enumsOptional

Filters the groups on basis of member type.

Allowed values: dev_userrev_user

modeenumOptional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore

namelist of stringsOptional

Filters the groups on the basis of group name.

sort_bylist of stringsOptional

Comma-separated fields to sort the groups by.

sync_metadata.external_referencelist of stringsOptional

Filters for issues with this specific external reference.

sync_metadata.last_sync_in.statuslist of enumsOptional

Filters for works with selected sync statuses.

Allowed values: failedmodifiedstagedsucceeded

sync_metadata.last_sync_in.sync_historylist of stringsOptional

Filters for works modified with selected sync history.

sync_metadata.last_sync_in.sync_unitlist of stringsOptional

Filters for works modified with selected sync units.

sync_metadata.last_sync_out.statuslist of enumsOptional

Filters for works with selected sync statuses.

Allowed values: failedmodifiedsucceeded

sync_metadata.last_sync_out.sync_historylist of stringsOptional

Filters for works modified with selected sync history.

sync_metadata.last_sync_out.sync_unitlist of stringsOptional

Filters for works modified with selected sync units.

sync_metadata.origin_systemlist of stringsOptional

Filters for issues synced from this specific origin system.

Response

The response to listing the groups.

groupslist of objects

The list of groups.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

GET

1 curl https://api.devrev.ai/groups.list \
2      -H "Authorization: Bearer <token>"

200listExample

1 {
2   "groups": [
3     {
4       "id": "foo",
5       "created_by": {
6         "display_id": "foo",
7         "id": "foo",
8         "display_name": "foo",
9         "display_picture": {
10           "display_id": "foo",
11           "id": "foo",
12           "file": {
13             "type": "foo",
14             "name": "foo",
15             "size": 42
16           }
17         },
18         "email": "foo",
19         "full_name": "foo",
20         "state": "active"
21       },
22       "created_date": "2023-01-01T12:00:00.000Z",
23       "display_id": "foo",
24       "modified_by": {
25         "display_id": "foo",
26         "id": "foo",
27         "display_name": "foo",
28         "display_picture": {
29           "display_id": "foo",
30           "id": "foo",
31           "file": {
32             "type": "foo",
33             "name": "foo",
34             "size": 42
35           }
36         },
37         "email": "foo",
38         "full_name": "foo",
39         "state": "active"
40       },
41       "modified_date": "2023-01-01T12:00:00.000Z"
42     }
43   ],
44   "next_cursor": "foo",
45   "prev_cursor": "foo"
46 }

List Groups (POST)

Up Next

Built with

1	curl https://api.devrev.ai/groups.list \
2	-H "Authorization: Bearer <token>"

1	{
2	"groups": [
3	{
4	"id": "foo",
5	"created_by": {
6	"display_id": "foo",
7	"id": "foo",
8	"display_name": "foo",
9	"display_picture": {
10	"display_id": "foo",
11	"id": "foo",
12	"file": {
13	"type": "foo",
14	"name": "foo",
15	"size": 42
16	}
17	},
18	"email": "foo",
19	"full_name": "foo",
20	"state": "active"
21	},
22	"created_date": "2023-01-01T12:00:00.000Z",
23	"display_id": "foo",
24	"modified_by": {
25	"display_id": "foo",
26	"id": "foo",
27	"display_name": "foo",
28	"display_picture": {
29	"display_id": "foo",
30	"id": "foo",
31	"file": {
32	"type": "foo",
33	"name": "foo",
34	"size": 42
35	}
36	},
37	"email": "foo",
38	"full_name": "foo",
39	"state": "active"
40	},
41	"modified_date": "2023-01-01T12:00:00.000Z"
42	}
43	],
44	"next_cursor": "foo",
45	"prev_cursor": "foo"
46	}