List Post

POST

Lists users within your organization.

Request

This endpoint expects an object.

created_dateobjectOptional

Provides ways to specify date ranges on objects.

cursorstringOptional

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

emaillist of stringsOptional

Filters Dev users based on email addresses.

external_identitylist of objectsOptional

Filters Dev users based on external identity.

limitintegerOptional

The maximum number of Dev users to return. The default is ‘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.

modified_dateobjectOptional

Provides ways to specify date ranges on objects.

sort_bylist of stringsOptional

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

statelist of enumsOptional

Filters Dev users based on state.

Response

The response to listing the Dev users.

dev_userslist of objects

The list of Dev 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/dev-users.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 {
2   "dev_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       "experience_start_date": "2023-01-01T12:00:00Z",
17       "external_identities": [
18         {}
19       ],
20       "full_name": "full_name",
21       "job_history": [
22         {
23           "end_date": "2023-01-01T12:00:00Z",
24           "start_date": "2023-01-01T12:00:00Z"
25         }
26       ],
27       "modified_by": {
28         "type": "sys_user",
29         "id": "modified_by"
30       },
31       "modified_date": "2023-01-01T12:00:00Z",
32       "phone_numbers": [
33         "phone_numbers"
34       ],
35       "skills": [
36         {}
37       ],
38       "state": "active"
39     }
40   ],
41   "next_cursor": "next_cursor",
42   "prev_cursor": "prev_cursor"
43 }

Built with

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

1	{
2	"dev_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	"experience_start_date": "2023-01-01T12:00:00Z",
17	"external_identities": [
18	{}
19	],
20	"full_name": "full_name",
21	"job_history": [
22	{
23	"end_date": "2023-01-01T12:00:00Z",
24	"start_date": "2023-01-01T12:00:00Z"
25	}
26	],
27	"modified_by": {
28	"type": "sys_user",
29	"id": "modified_by"
30	},
31	"modified_date": "2023-01-01T12:00:00Z",
32	"phone_numbers": [
33	"phone_numbers"
34	],
35	"skills": [
36	{}
37	],
38	"state": "active"
39	}
40	],
41	"next_cursor": "next_cursor",
42	"prev_cursor": "prev_cursor"
43	}