List Post

POST

Lists system users within your organization.

Request

This endpoint expects an object.

cursorstringOptional

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

limitintegerOptional

The maximum number of system users to return. Value can range from ‘1’ to ‘100’, with a default of ‘50’.

mode"after" or "before"Optional

Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

sort_bylist of stringsOptional

Fields to sort the system users by and the direction to sort them.

Response

This endpoint returns an object.

sys_userslist of objects

The list of system users.

next_cursorstringOptional

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

prev_cursorstringOptional

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

POST

1 curl -X POST https://api.devrev.ai/sys-users.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 {
2   "sys_users": [
3     {
4       "id": "id",
5       "created_by": {
6         "type": "sys_user",
7         "id": "created_by"
8       },
9       "created_date": "2023-01-01T12:00:00Z",
10       "display_id": "display_id",
11       "display_name": "display_name",
12       "display_picture": {
13         "id": "id"
14       },
15       "email": "email",
16       "full_name": "full_name",
17       "modified_by": {
18         "type": "sys_user",
19         "id": "modified_by"
20       },
21       "modified_date": "2023-01-01T12:00:00Z",
22       "phone_numbers": [
23         "phone_numbers"
24       ],
25       "state": "active"
26     }
27   ],
28   "next_cursor": "next_cursor",
29   "prev_cursor": "prev_cursor"
30 }

Built with

1	curl -X POST https://api.devrev.ai/sys-users.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"sys_users": [
3	{
4	"id": "id",
5	"created_by": {
6	"type": "sys_user",
7	"id": "created_by"
8	},
9	"created_date": "2023-01-01T12:00:00Z",
10	"display_id": "display_id",
11	"display_name": "display_name",
12	"display_picture": {
13	"id": "id"
14	},
15	"email": "email",
16	"full_name": "full_name",
17	"modified_by": {
18	"type": "sys_user",
19	"id": "modified_by"
20	},
21	"modified_date": "2023-01-01T12:00:00Z",
22	"phone_numbers": [
23	"phone_numbers"
24	],
25	"state": "active"
26	}
27	],
28	"next_cursor": "next_cursor",
29	"prev_cursor": "prev_cursor"
30	}