Returns all users with their details.

GET

https://api.awork.com/api/v1/users

GET

/api/v1/users

$ curl https://api.awork.com/api/v1/users \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "firstName": "Carla",
4     "lastName": "Creative",
5     "birthDate": "1998-04-19T00:00:00Z",
6     "gender": "female",
7     "title": "Miss",
8     "position": "Graphic Designer",
9     "language": "en-GB",
10     "id": "123e4567-e89b-12d3-a456-426614174000",
11     "status": {
12       "invitationAccepted": true,
13       "isDeactivated": false
14     },
15     "createdOn": "2023-11-10T08:45:00Z",
16     "createdBy": "987f6543-e21b-45d3-b789-123456789abc",
17     "updatedOn": "2024-04-01T12:00:00Z",
18     "updatedBy": "987f6543-e21b-45d3-b789-123456789abc",
19     "isArchived": false,
20     "isDeactivated": false,
21     "isAgent": false,
22     "deactivatedOn": null,
23     "deletedOn": null,
24     "hasImage": true,
25     "shouldMigrateToConnect": false,
26     "userContactInfos": [
27       {
28         "label": null,
29         "value": null,
30         "type": "address",
31         "subType": "work",
32         "addressLine1": "Torstrasse 140",
33         "addressLine2": "Hof A",
34         "zipCode": "10119",
35         "city": "Berlin",
36         "state": null,
37         "country": "DE",
38         "isAddress": true,
39         "id": "a12b3456-c78d-90ef-1234-56789abcdef0",
40         "createdOn": "2023-11-10T08:45:00Z",
41         "createdBy": "987f6543-e21b-45d3-b789-123456789abc",
42         "updatedOn": "2024-04-01T12:00:00Z",
43         "updatedBy": "987f6543-e21b-45d3-b789-123456789abc"
44       },
45       {
46         "label": null,
47         "value": "carla.creative@example.com",
48         "type": "email",
49         "subType": "work",
50         "addressLine1": null,
51         "addressLine2": null,
52         "zipCode": null,
53         "city": null,
54         "state": null,
55         "country": null,
56         "isAddress": false,
57         "id": "b23c4567-d89e-01fa-2345-67890bcdef12",
58         "createdOn": "2023-11-10T08:45:00Z",
59         "createdBy": "987f6543-e21b-45d3-b789-123456789abc",
60         "updatedOn": "2024-04-01T12:00:00Z",
61         "updatedBy": "987f6543-e21b-45d3-b789-123456789abc"
62       },
63       {
64         "label": null,
65         "value": "+49 30 12345678",
66         "type": "phone",
67         "subType": "work",
68         "addressLine1": null,
69         "addressLine2": null,
70         "zipCode": null,
71         "city": null,
72         "state": null,
73         "country": null,
74         "isAddress": false,
75         "id": "c34d5678-e90f-12ab-3456-78901cdef234",
76         "createdOn": "2023-11-10T08:45:00Z",
77         "createdBy": "987f6543-e21b-45d3-b789-123456789abc",
78         "updatedOn": "2024-04-01T12:00:00Z",
79         "updatedBy": "987f6543-e21b-45d3-b789-123456789abc"
80       }
81     ],
82     "resourceVersion": 637825154598057900,
83     "tags": [
84       {
85         "id": "d45e6789-f01a-23bc-4567-89012def3456",
86         "name": "Design",
87         "color": "purple"
88       }
89     ],
90     "teams": [
91       {
92         "id": "e56f7890-12bc-34de-5678-90123ef45678",
93         "name": "Designers",
94         "icon": "paintbrush",
95         "color": "purple"
96       }
97     ],
98     "isExternal": false
99   }
100 ]

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.

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. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

showArchivedbooleanOptionalDefaults to false

Whether to show archived users.

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

firstNamestring or nullOptional0-1000 characters

The firstname of the user.

lastNamestring or nullOptional0-1000 characters

The lastname of the user.

birthDatestring or nullOptionalformat: "date-time"

The birthdate of the user.

genderstring or nullOptional0-25 characters

The gender of the user.

titlestring or nullOptional0-100 characters

The title of the user.

positionstring or nullOptional0-1000 characters

The position of the user.

languagestring or nullOptional0-25 characters

The language preference of the user in ISO 639-1 format.

idstringOptionalformat: "uuid"

The id of the user.

statusobjectOptional

The status of the user.

createdOnstringOptionalformat: "date-time"

The date this user was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this user.

updatedOnstringOptionalformat: "date-time"

The date when this user was last updated.

updatedBystringOptionalformat: "uuid"

The id of the user who updated the entity.

isArchivedbooleanOptional

Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.

isDeactivatedbooleanOptional

Whether the user has been deactivated.

isAgentbooleanOptional

Whether this user represents an agent.

deactivatedOnstring or nullOptionalformat: "date-time"

The date the user was deactivated.

deletedOnstring or nullOptionalformat: "date-time"

The date the user was deleted (soft delete).

hasImagebooleanOptional

Whether the user has uploaded a profile image.

shouldMigrateToConnectbooleanOptional

Whether the user should be migrated to Connect.

userContactInfoslist of objects or nullOptional

The contact information assigned to this user.

resourceVersionlongOptionalRead-only

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

tagslist of objects or nullOptional

The tags of this user.

teamslist of objects or nullOptional

The teams the user is associated to.

isExternalbooleanOptional

True if this entity is coming from an external workspace (awork Connect).