Returns all users.

GET

Returns all users with their details like status, contact info and more. Returns all users if the user has read permissions on the feature user-master-data, otherwise returns only his own user. Archived users are excluded by default. You can include them by setting the ‘showArchived’ query parameter. If the permissions have UserTeamsData Feature, the filter for teams is applied. Beware that this will also include API users in the response.

Required Permissions: Any authenticated user.

Query parameters

showArchivedbooleanOptionalDefaults to false

Include archived users in the results. Not required. False by default.

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

Response

list of objects or null

GET

1 curl https://api.awork.com/api/v1/users \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "firstName": "Carla",
4     "lastName": "Creative",
5     "birthDate": "2024-01-15T09:30:00Z",
6     "gender": "female",
7     "title": "Miss",
8     "position": "position",
9     "language": "en-GB",
10     "id": "123e4567-e89b-12d3-a456-426614174000",
11     "status": {
12       "invitationAccepted": true,
13       "isDeactivated": true
14     },
15     "createdOn": "2024-01-15T09:30:00Z",
16     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
17     "updatedOn": "2024-01-15T09:30:00Z",
18     "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
19     "isArchived": false,
20     "isDeactivated": false,
21     "deactivatedOn": "2024-01-15T09:30:00Z",
22     "hasImage": true,
23     "shouldMigrateToConnect": true,
24     "userContactInfos": [
25       {
26         "isAddress": true,
27         "id": "123e4567-e89b-12d3-a456-426614174000",
28         "isDeleted": false
29       }
30     ],
31     "resourceVersion": 637825154598057900,
32     "tags": [
33       {
34         "id": "123e4567-e89b-12d3-a456-426614174000"
35       }
36     ],
37     "teams": [
38       {
39         "id": "123e4567-e89b-12d3-a456-426614174000"
40       }
41     ],
42     "isExternal": true
43   }
44 ]

Returns the user with the specified id.

Up Next

Built with

1	curl https://api.awork.com/api/v1/users \
2	-H "Authorization: Bearer <token>"

1	[
2	{
3	"firstName": "Carla",
4	"lastName": "Creative",
5	"birthDate": "2024-01-15T09:30:00Z",
6	"gender": "female",
7	"title": "Miss",
8	"position": "position",
9	"language": "en-GB",
10	"id": "123e4567-e89b-12d3-a456-426614174000",
11	"status": {
12	"invitationAccepted": true,
13	"isDeactivated": true
14	},
15	"createdOn": "2024-01-15T09:30:00Z",
16	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
17	"updatedOn": "2024-01-15T09:30:00Z",
18	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
19	"isArchived": false,
20	"isDeactivated": false,
21	"deactivatedOn": "2024-01-15T09:30:00Z",
22	"hasImage": true,
23	"shouldMigrateToConnect": true,
24	"userContactInfos": [
25	{
26	"isAddress": true,
27	"id": "123e4567-e89b-12d3-a456-426614174000",
28	"isDeleted": false
29	}
30	],
31	"resourceVersion": 637825154598057900,
32	"tags": [
33	{
34	"id": "123e4567-e89b-12d3-a456-426614174000"
35	}
36	],
37	"teams": [
38	{
39	"id": "123e4567-e89b-12d3-a456-426614174000"
40	}
41	],
42	"isExternal": true
43	}
44	]