Returns the user with the specified id.

GET

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

Play

200Retrieved

1 {
2   "firstName": "Carla",
3   "lastName": "Creative",
4   "birthDate": "1998-04-19T00:00:000Z",
5   "gender": "female",
6   "title": "Miss",
7   "position": null,
8   "language": "en-GB",
9   "id": "123e4567-e89b-12d3-a456-426614174000",
10   "status": {
11     "invitationAccepted": false,
12     "isDeactivated": false
13   },
14   "createdOn": "createdOn",
15   "createdBy": "123e4567-e89b-12d3-a456-426614174000",
16   "updatedOn": "updatedOn",
17   "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
18   "isArchived": false,
19   "isDeactivated": false,
20   "deactivatedOn": null,
21   "hasImage": true,
22   "shouldMigrateToConnect": false,
23   "userContactInfos": [
24     {
25       "label": null,
26       "value": null,
27       "type": "address",
28       "subType": "work",
29       "addressLine1": "Torstrasse 140",
30       "addressLine2": "Hof A",
31       "zipCode": "10119",
32       "city": "Berlin",
33       "state": null,
34       "country": "DE",
35       "isAddress": true,
36       "id": "123e4567-e89b-12d3-a456-426614174000",
37       "isDeleted": false,
38       "createdOn": "createdOn",
39       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
40       "updatedOn": "updatedOn",
41       "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
42     }
43   ],
44   "resourceVersion": 637825154598057900,
45   "tags": [
46     {
47       "id": "123e4567-e89b-12d3-a456-426614174000",
48       "name": "Design",
49       "color": "purple"
50     }
51   ],
52   "teams": [
53     {
54       "id": "123e4567-e89b-12d3-a456-426614174000",
55       "name": "Designers",
56       "icon": "paintbrush",
57       "color": "purple"
58     }
59   ],
60   "isExternal": true
61 }

Required Permissions

Any authenticated user.

Path parameters

userIdUUIDRequired

The id of the user.

Response

firstNamestring or nullOptional>=0 characters<=1000 characters

The firstname of the user.

lastNamestring or nullOptional>=0 characters<=1000 characters

The lastname of the user.

birthDatedatetime or nullOptional

The birthdate of the user.

genderstring or nullOptional>=0 characters<=25 characters

The gender of the user.

titlestring or nullOptional>=0 characters<=100 characters

The title of the user.

positionstring or nullOptional>=0 characters<=1000 characters

The position of the user.

languagestring or nullOptional>=0 characters<=25 characters

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

idUUIDOptional

The id of the user.

statusobjectOptional

The status of the user.

createdOndatetimeOptional

The date this user was created.

createdByUUIDOptional

The id of the user who created this user.

updatedOndatetimeOptional

The date when this user was last updated.

updatedByUUIDOptional

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.

deactivatedOndatetime or nullOptional

The date the user was deactivated.

hasImagebooleanOptional

Whether the user has uploaded a profile image.

shouldMigrateToConnectbooleanOptional

Whether the user should be migrated to Connect.

userContactInfoslist of objectsOptional

The contact information assigned to this user.

resourceVersionlongOptional

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

tagslist of objectsOptional

The tags of this user.

teamslist of objectsOptional

The teams the user is associated to.

isExternalbooleanOptional

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

Required Permissions

Path parameters

Headers

Response