Axsync API v2

Members

People who can access a workspace and the role each one has.

The member object

FieldTypeDescription
idstringUnique identifier, prefixed with mb_.
user_idstringThe user.
role requiredstringowner, admin, editor or viewer.
emailstringMember email.
created_attimestampCreation time, RFC 3339 in UTC.

Example

{
  "id": "mb_8f3k2Q9xLm",
  "user_id": "us_5Kd9PaT3",
  "role": "editor",
  "email": "sam@example.com",
  "created_at": "2026-09-14T08:21:07Z"
}

GET /workspaces/{workspace_id}/members

List members. Returns a paginated list of members.

Required scope: members:read

Query parameters

FieldTypeDescription
limitintegerPage size, 1–100. Default 25.
cursorstringCursor from the previous page.
sortstringField to sort by, prefix - for descending.
filterstringFilter expression, see Filtering and sorting.

Request

curl -X GET "https://api.axnode.net/v2/workspaces/workspace_id/members" \
  -H "Authorization: Bearer $AXSYNC_TOKEN"
const res = await fetch('https://api.axnode.net/v2/workspaces/workspace_id/members', {
  method: 'GET',
  headers: { Authorization: `Bearer ${token}` }
});
const data = await res.json();
import requests

res = requests.get(
    'https://api.axnode.net/v2/workspaces/workspace_id/members',
    headers={'Authorization': f'Bearer {token}'},
)
data = res.json()

Response 200

{
  "data": [
    {
      "id": "mb_8f3k2Q9xLm",
      "user_id": "us_5Kd9PaT3",
      "role": "editor",
      "email": "sam@example.com",
      "created_at": "2026-09-14T08:21:07Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET /workspaces/{workspace_id}/members/{id}

Retrieve a member. Retrieves a member by its identifier.

Required scope: members:read

Request

curl -X GET "https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm" \
  -H "Authorization: Bearer $AXSYNC_TOKEN"
const res = await fetch('https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm', {
  method: 'GET',
  headers: { Authorization: `Bearer ${token}` }
});
const data = await res.json();
import requests

res = requests.get(
    'https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm',
    headers={'Authorization': f'Bearer {token}'},
)
data = res.json()

Response 200

{
  "id": "mb_8f3k2Q9xLm",
  "user_id": "us_5Kd9PaT3",
  "role": "editor",
  "email": "sam@example.com",
  "created_at": "2026-09-14T08:21:07Z"
}

PATCH /workspaces/{workspace_id}/members/{id}

Update a member. Updates fields of a member. Only supplied fields change.

Required scope: members:write

Body parameters

FieldTypeDescription
user_idstringThe user.
role requiredstringowner, admin, editor or viewer.
emailstringMember email.

Request

curl -X PATCH "https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm" \
  -H "Authorization: Bearer $AXSYNC_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"role": "editor"}'
const res = await fetch('https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm', {
  method: 'PATCH',
  headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"role": "editor"})
});
const data = await res.json();
import requests

res = requests.patch(
    'https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm',
    headers={'Authorization': f'Bearer {token}'}, json={"role": "editor"},
)
data = res.json()

Response 200

{
  "id": "mb_8f3k2Q9xLm",
  "user_id": "us_5Kd9PaT3",
  "role": "editor",
  "email": "sam@example.com",
  "created_at": "2026-09-14T08:21:07Z"
}

DELETE /workspaces/{workspace_id}/members/{id}

Delete a member. Permanently deletes a member. This cannot be undone.

Required scope: members:write

Request

curl -X DELETE "https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm" \
  -H "Authorization: Bearer $AXSYNC_TOKEN"
const res = await fetch('https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm', {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${token}` }
});
const data = await res.json();
import requests

res = requests.delete(
    'https://api.axnode.net/v2/workspaces/workspace_id/members/mb_8f3k2Q9xLm',
    headers={'Authorization': f'Bearer {token}'},
)
data = res.json()

Response 200

{
  "deleted": true,
  "id": "mb_8f3k2Q9xLm"
}