Workspace Users
List workspace users, invite by email, change roles, remove users; create, get, update, and delete external users. All operations are scoped to the API key’s workspace.
List users
GET /api/v2/users
List all users in the API key’s workspace (id, email, name, role, etc.).
curl "https://api.markup.io/api/v2/users" \
-X GET \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" 204 No ContentInvite users
POST /api/v2/users/invite
Invites people to join the workspace as members. Body: emails (array, max 25).
Accepting grants access to every markup in the workspace, present and future - it is not scoped to
one markup, and there is no way to narrow it here. To give someone access to a single markup instead,
use that markup’s share link, which admits them as
a contributor on that markup alone.
There is no custom-message field: the workspace invite email has nowhere to render one. Use
Invite to Markup when the note has to reach the
recipient. A message sent here is ignored rather than rejected, so existing callers are unaffected.
Invites are attributed to the API key’s user, so they appear to come from the key’s name rather than
from the person who created it. Rate limited per organization on the same allowance as the web app.
curl "https://api.markup.io/api/v2/users/invite" \
-X POST \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" \
--data '{
"emails": [
"some string"
]
}'204 No ContentRequest Body InviteUsersRequest
| Option | Type | |
|---|---|---|
| emails | string[] | Addresses to invite to the workspace, at most 25 per request. Each recipient gains access to every markup in the workspace. |
Update user role
PATCH /api/v2/users/:userId/role
Change a workspace member’s role. Params: userId. Body: role (e.g. owner, admin, contributor, viewer).
curl "https://api.markup.io/api/v2/users/a7368b2b-7182-40fa-bb72-74abc7c16b29/role" \
-X PATCH \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" \
--data '{
"role": {}
}'204 No ContentRequest Path Params UserIdParam
| Option | Type | |
|---|---|---|
| userId | string |
Request Body UpdateUserRoleRequest
| Option | Type | |
|---|---|---|
| role | UpdateUserRoleRequestRole |
Remove user
DELETE /api/v2/users/:userId
Remove a user from the workspace. Params: userId.
curl "https://api.markup.io/api/v2/users/a7368b2b-7182-40fa-bb72-74abc7c16b29" \
-X DELETE \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" 204 No ContentRequest Path Params UserIdParam
| Option | Type | |
|---|---|---|
| userId | string |
Create external user
POST /api/v2/users/external
Create an external (feedback) user. Body: externalId (required), optional name, email, avatarUrl, avatarFileId.
curl "https://api.markup.io/api/v2/users/external" \
-X POST \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" \
--data '{
"externalId": "some externalId"
}'204 No ContentRequest Body CreateExternalUserRequest
| Option | Type | |
|---|---|---|
| externalId | string | |
| name optional | string | |
| email optional | string | |
| avatarUrl optional | string | |
| avatarFileId optional | string |
Get external user
GET /api/v2/users/external/:externalId
Get an external user by externalId. Params: externalId.
curl "https://api.markup.io/api/v2/users/external/some externalId" \
-X GET \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" 204 No ContentRequest Path Params ExternalIdParam
| Option | Type | |
|---|---|---|
| externalId | string |
Update external user
PATCH /api/v2/users/external/:externalId
Update an external user. Params: externalId. Body: optional name, email, avatarUrl, avatarFileId.
curl "https://api.markup.io/api/v2/users/external/some externalId" \
-X PATCH \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" \
--data '{}'204 No ContentRequest Path Params ExternalIdParam
| Option | Type | |
|---|---|---|
| externalId | string |
Request Body UpdateExternalUserRequest
| Option | Type | |
|---|---|---|
| name optional | string | |
| email optional | string | |
| avatarUrl optional | string | |
| avatarFileId optional | string |
Delete external user
DELETE /api/v2/users/external/:externalId
Delete an external user from the workspace. Params: externalId.
curl "https://api.markup.io/api/v2/users/external/some externalId" \
-X DELETE \
-H "Authorization: Bearer <API-KEY-SECRET>" \
-H "Markup-API-Version: 2023-02-22" \
-H "Content-Type: application/json" 204 No ContentRequest Path Params ExternalIdParam
| Option | Type | |
|---|---|---|
| externalId | string |