Skip to Content
APIResourcesAdmin APIWorkspace Users

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.).

GET /api/v2/users
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"
Response
204 No Content

Invite 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.

POST /api/v2/users/invite
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" ] }'
Response
204 No Content

Request Body InviteUsersRequest

OptionType
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).

PATCH /api/v2/users/:userId/role
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": {} }'
Response
204 No Content

Request Path Params UserIdParam

OptionType
userId string

Request Body UpdateUserRoleRequest

OptionType
role UpdateUserRoleRequestRole

Remove user

DELETE /api/v2/users/:userId

Remove a user from the workspace. Params: userId.

DELETE /api/v2/users/: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"
Response
204 No Content

Request Path Params UserIdParam

OptionType
userId string

Create external user

POST /api/v2/users/external

Create an external (feedback) user. Body: externalId (required), optional name, email, avatarUrl, avatarFileId.

POST /api/v2/users/external
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" }'
Response
204 No Content

Request Body CreateExternalUserRequest

OptionType
externalId string
name optionalstring
email optionalstring
avatarUrl optionalstring
avatarFileId optionalstring

Get external user

GET /api/v2/users/external/:externalId

Get an external user by externalId. Params: externalId.

GET /api/v2/users/external/: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"
Response
204 No Content

Request Path Params ExternalIdParam

OptionType
externalId string

Update external user

PATCH /api/v2/users/external/:externalId

Update an external user. Params: externalId. Body: optional name, email, avatarUrl, avatarFileId.

PATCH /api/v2/users/external/:externalId
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 '{}'
Response
204 No Content

Request Path Params ExternalIdParam

OptionType
externalId string

Request Body UpdateExternalUserRequest

OptionType
name optionalstring
email optionalstring
avatarUrl optionalstring
avatarFileId optionalstring

Delete external user

DELETE /api/v2/users/external/:externalId

Delete an external user from the workspace. Params: externalId.

DELETE /api/v2/users/external/: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"
Response
204 No Content

Request Path Params ExternalIdParam

OptionType
externalId string
Last updated on