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       "is_default": true,
6       "created_by": {
7         "display_id": "foo",
8         "id": "foo",
9         "display_name": "foo",
10         "display_picture": {
11           "display_id": "foo",
12           "id": "foo",
13           "file": {
14             "type": "foo",
15             "name": "foo",
16             "size": 42
17           }
18         },
19         "email": "foo",
20         "full_name": "foo",
21         "state": "active"
22       },
23       "created_date": "2023-01-01T12:00:00.000Z",
24       "description": "foo",
25       "display_id": "foo",
26       "member_type": "dev_user",
27       "modified_by": {
28         "display_id": "foo",
29         "id": "foo",
30         "display_name": "foo",
31         "display_picture": {
32           "display_id": "foo",
33           "id": "foo",
34           "file": {
35             "type": "foo",
36             "name": "foo",
37             "size": 42
38           }
39         },
40         "email": "foo",
41         "full_name": "foo",
42         "state": "active"
43       },
44       "modified_date": "2023-01-01T12:00:00.000Z",
45       "name": "foo",
46       "owner": {
47         "display_id": "foo",
48         "id": "foo",
49         "display_name": "foo",
50         "display_picture": {
51           "display_id": "foo",
52           "id": "foo",
53           "file": {
54             "type": "foo",
55             "name": "foo",
56             "size": 42
57           }
58         },
59         "email": "foo",
60         "full_name": "foo",
61         "state": "active"
62       },
63       "sync_metadata": {
64         "external_reference": "foo",
65         "last_sync_in": {
66           "status": "failed",
67           "sync_date": "2023-01-01T12:00:00.000Z",
68           "sync_unit": {
69             "id": "foo",
70             "display_id": "foo",
71             "external_system_type": "adaas",
72             "is_archived": true,
73             "name": "foo",
74             "sync_run": {
75               "mode": "initial",
76               "progress": {
77                 "state": "completed"
78               }
79             },
80             "sync_type": "manual"
81           }
82         },
83         "last_sync_out": {
84           "status": "failed",
85           "sync_date": "2023-01-01T12:00:00.000Z",
86           "sync_unit": {
87             "id": "foo",
88             "display_id": "foo",
89             "external_system_type": "adaas",
90             "is_archived": true,
91             "name": "foo",
92             "sync_run": {
93               "mode": "initial",
94               "progress": {
95                 "state": "completed"
96               }
97             },
98             "sync_type": "manual"
99           }
100         },
101         "origin_system": "foo"
102       }
103     }
104   ],
105   "next_cursor": "foo",
106   "prev_cursor": "foo"
107 }

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	"is_default": true,
6	"created_by": {
7	"display_id": "foo",
8	"id": "foo",
9	"display_name": "foo",
10	"display_picture": {
11	"display_id": "foo",
12	"id": "foo",
13	"file": {
14	"type": "foo",
15	"name": "foo",
16	"size": 42
17	}
18	},
19	"email": "foo",
20	"full_name": "foo",
21	"state": "active"
22	},
23	"created_date": "2023-01-01T12:00:00.000Z",
24	"description": "foo",
25	"display_id": "foo",
26	"member_type": "dev_user",
27	"modified_by": {
28	"display_id": "foo",
29	"id": "foo",
30	"display_name": "foo",
31	"display_picture": {
32	"display_id": "foo",
33	"id": "foo",
34	"file": {
35	"type": "foo",
36	"name": "foo",
37	"size": 42
38	}
39	},
40	"email": "foo",
41	"full_name": "foo",
42	"state": "active"
43	},
44	"modified_date": "2023-01-01T12:00:00.000Z",
45	"name": "foo",
46	"owner": {
47	"display_id": "foo",
48	"id": "foo",
49	"display_name": "foo",
50	"display_picture": {
51	"display_id": "foo",
52	"id": "foo",
53	"file": {
54	"type": "foo",
55	"name": "foo",
56	"size": 42
57	}
58	},
59	"email": "foo",
60	"full_name": "foo",
61	"state": "active"
62	},
63	"sync_metadata": {
64	"external_reference": "foo",
65	"last_sync_in": {
66	"status": "failed",
67	"sync_date": "2023-01-01T12:00:00.000Z",
68	"sync_unit": {
69	"id": "foo",
70	"display_id": "foo",
71	"external_system_type": "adaas",
72	"is_archived": true,
73	"name": "foo",
74	"sync_run": {
75	"mode": "initial",
76	"progress": {
77	"state": "completed"
78	}
79	},
80	"sync_type": "manual"
81	}
82	},
83	"last_sync_out": {
84	"status": "failed",
85	"sync_date": "2023-01-01T12:00:00.000Z",
86	"sync_unit": {
87	"id": "foo",
88	"display_id": "foo",
89	"external_system_type": "adaas",
90	"is_archived": true,
91	"name": "foo",
92	"sync_run": {
93	"mode": "initial",
94	"progress": {
95	"state": "completed"
96	}
97	},
98	"sync_type": "manual"
99	}
100	},
101	"origin_system": "foo"
102	}
103	}
104	],
105	"next_cursor": "foo",
106	"prev_cursor": "foo"
107	}