Users

Users represent the people who are part of an awork workspace. They can be assigned to tasks, projects, and other resources. Users can have different roles and permissions in the workspace.

Inviting Users

To invite a new user to an awork workspace, you need to make a request to POST /invitations. This is one of the few requests that requires a workspaceId.

Request

1 curl -X POST https://api.awork.com/api/v1/invitations \
2   -H 'Content-Type: application/json' \
3   -d '{
4 	"email": "carla.creative@ncnstn.com",
5 	"invitationFlow": "invite",
6 	"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
7 	"roleId": "123e4567-e89b-12d3-a456-426614174000"
8   }'

You can find the workspace id of the current user by making a request to the /users/me endpoint.

Request

1 curl -X GET https://api.awork.com/api/v1/users/me

Response

1 {
2 	"id": "123e4567-e89b-12d3-a456-426614174000",
3 	"workspace": {
4 		"id": "123e4567-e89b-12d3-a456-426614174000",
5 		"name": "NCNSTN",
6 		"url": "https://ncnstn.awork.com"
7 	}
8 }

1	curl -X POST https://api.awork.com/api/v1/invitations \
2	-H 'Content-Type: application/json' \
3	-d '{
4	"email": "carla.creative@ncnstn.com",
5	"invitationFlow": "invite",
6	"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
7	"roleId": "123e4567-e89b-12d3-a456-426614174000"
8	}'

1	{
2	"id": "123e4567-e89b-12d3-a456-426614174000",
3	"workspace": {
4	"id": "123e4567-e89b-12d3-a456-426614174000",
5	"name": "NCNSTN",
6	"url": "https://ncnstn.awork.com"
7	}
8	}