Members

Manage organization members and invitations.

Members

Manage who has access to your organization and individual workspaces. Invite new members by email, manage roles, and control workspace-level access.

Organization Members

GET/api/v1/members

List all members of your organization.

Response

json

{
  "members": [
    {
      "id": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "user123",
      "role": "owner",
      "userName": "Jane Smith",
      "userEmail": "[email protected]",
      "userImage": null,
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "total": 1
}

Example

bash

curl https://api.weavz.io/api/v1/members \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

import { WeavzClient } from '@weavz/sdk'
 
const client = new WeavzClient({ apiKey: 'wvz_your_api_key' })
 
const { members } = await client.members.list()

python

from weavz_sdk import WeavzClient
 
client = WeavzClient(api_key="wvz_your_api_key")
 
result = client.members.list()
members = result["members"]

typescript

const res = await fetch('https://api.weavz.io/api/v1/members', {
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

import httpx
 
res = httpx.get(
    "https://api.weavz.io/api/v1/members",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Invitations

POST/api/v1/members/invite

Invite a new member to your organization by email. The invited user will receive an email with a link to accept the invitation. Invitations expire after 7 days.

Request Body

Field	Type	Required	Description
`email`	string	Yes	Email address to invite
`role`	string	No	`admin` or `member` (default: `member`)

Response

json

{
  "invitation": {
    "id": "inv-abc123",
    "email": "[email protected]",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "role": "member",
    "status": "pending",
    "expiresAt": "2025-01-23T14:00:00.000Z",
    "createdAt": "2025-01-16T14:00:00.000Z"
  }
}

Example

bash

curl -X POST https://api.weavz.io/api/v1/members/invite \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "role": "admin"}'

typescript

const { invitation } = await client.invitations.send({
  email: '[email protected]',
  role: 'admin',
})

python

result = client.invitations.send(email="[email protected]", role="admin")

typescript

const res = await fetch('https://api.weavz.io/api/v1/members/invite', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer wvz_your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ email: '[email protected]', role: 'admin' }),
})
const data = await res.json()

python

res = httpx.post(
    "https://api.weavz.io/api/v1/members/invite",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={"email": "[email protected]", "role": "admin"},
)
data = res.json()

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	Invalid email address
`403`	`QUOTA_EXCEEDED`	Member limit reached for your plan
`409`	`DUPLICATE`	User is already a member or has a pending invitation

GET/api/v1/members/invitations

List all pending invitations for your organization.

Response

json

{
  "invitations": [
    {
      "id": "inv-abc123",
      "email": "[email protected]",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "role": "member",
      "status": "pending",
      "expiresAt": "2025-01-23T14:00:00.000Z",
      "createdAt": "2025-01-16T14:00:00.000Z"
    }
  ]
}

Example

bash

curl https://api.weavz.io/api/v1/members/invitations \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

const { invitations } = await client.invitations.list()

python

result = client.invitations.list()
invitations = result["invitations"]

typescript

const res = await fetch('https://api.weavz.io/api/v1/members/invitations', {
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

res = httpx.get(
    "https://api.weavz.io/api/v1/members/invitations",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

DELETE/api/v1/members/invitations/:invitationId

Revoke a pending invitation.

Path Parameters

Field	Type	Description
`invitationId`	string	Invitation ID

Response

json

{
  "deleted": true,
  "id": "inv-abc123"
}

Example

bash

curl -X DELETE https://api.weavz.io/api/v1/members/invitations/inv-abc123 \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

await client.invitations.revoke('inv-abc123')

python

client.invitations.revoke("inv-abc123")

typescript

const res = await fetch('https://api.weavz.io/api/v1/members/invitations/inv-abc123', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

res = httpx.delete(
    "https://api.weavz.io/api/v1/members/invitations/inv-abc123",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Invitation not found

POST/api/v1/members/invitations/:invitationId/accept

Accept an invitation to join an organization. The authenticated user must match the invited email address.

Path Parameters

Field	Type	Description
`invitationId`	string	Invitation ID

Response

json

{
  "member": {
    "id": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "user456",
    "role": "member",
    "createdAt": "2025-01-16T14:00:00.000Z"
  }
}

Example

bash

curl -X POST https://api.weavz.io/api/v1/members/invitations/inv-abc123/accept \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

const { member } = await client.invitations.accept('inv-abc123')

python

result = client.invitations.accept("inv-abc123")

typescript

const res = await fetch('https://api.weavz.io/api/v1/members/invitations/inv-abc123/accept', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

res = httpx.post(
    "https://api.weavz.io/api/v1/members/invitations/inv-abc123/accept",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Errors

Status	Code	Description
`403`	`FORBIDDEN`	Authenticated user's email does not match invitation
`404`	`NOT_FOUND`	Invitation not found or already accepted
`400`	`EXPIRED`	Invitation has expired
`409`	`DUPLICATE`	Already a member of this organization

Manage Members

PATCH/api/v1/members/:id

Update a member's role.

Path Parameters

Field	Type	Description
`id`	string	Member ID

Request Body

Field	Type	Required	Description
`role`	string	Yes	`owner`, `admin`, or `member`

Response

json

{
  "member": {
    "id": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "userId": "user456",
    "role": "admin",
    "createdAt": "2025-01-16T14:00:00.000Z"
  }
}

Example

bash

curl -X PATCH https://api.weavz.io/api/v1/members/m1a2b3c4-d5e6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"role": "admin"}'

typescript

const { member } = await client.members.update('m1a2b3c4-d5e6-7890-abcd-ef1234567890', {
  role: 'admin',
})

python

result = client.members.update("m1a2b3c4-d5e6-7890-abcd-ef1234567890", role="admin")

typescript

const res = await fetch('https://api.weavz.io/api/v1/members/m1a2b3c4-d5e6-7890-abcd-ef1234567890', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer wvz_your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ role: 'admin' }),
})
const data = await res.json()

python

res = httpx.patch(
    "https://api.weavz.io/api/v1/members/m1a2b3c4-d5e6-7890-abcd-ef1234567890",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={"role": "admin"},
)
data = res.json()

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	Invalid role (must be `owner`, `admin`, or `member`)
`404`	`NOT_FOUND`	Member not found

DELETE/api/v1/members/:id

Remove a member from your organization.

Path Parameters

Field	Type	Description
`id`	string	Member ID

Response

json

{
  "deleted": true,
  "id": "m1a2b3c4-d5e6-7890-abcd-ef1234567890"
}

Example

bash

curl -X DELETE https://api.weavz.io/api/v1/members/m1a2b3c4-d5e6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

await client.members.delete('m1a2b3c4-d5e6-7890-abcd-ef1234567890')

python

client.members.delete("m1a2b3c4-d5e6-7890-abcd-ef1234567890")

typescript

const res = await fetch('https://api.weavz.io/api/v1/members/m1a2b3c4-d5e6-7890-abcd-ef1234567890', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

res = httpx.delete(
    "https://api.weavz.io/api/v1/members/m1a2b3c4-d5e6-7890-abcd-ef1234567890",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Member not found

Workspace Members

POST/api/v1/workspace-members

Add an organization member to a workspace.

Request Body

Field	Type	Required	Description
`workspaceId`	string (uuid)	Yes	Workspace ID
`memberId`	string	Yes	Organization member ID
`role`	string	No	`admin` or `member` (default: `member`)

Response (201)

json

{
  "projectMember": {
    "id": "pm1a2b3c-d5e6-7890-abcd-ef1234567890",
    "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "memberId": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "role": "member",
    "createdAt": "2025-01-16T14:00:00.000Z"
  }
}

Example

bash

curl -X POST https://api.weavz.io/api/v1/workspace-members \
  -H "Authorization: Bearer wvz_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "memberId": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "role": "member"
  }'

typescript

const { projectMember } = await client.projectMembers.create({
  workspaceId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  memberId: 'm1a2b3c4-d5e6-7890-abcd-ef1234567890',
  role: 'member',
})

python

result = client.workspace_members.create(
    workspace_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    member_id="m1a2b3c4-d5e6-7890-abcd-ef1234567890",
    role="member",
)

typescript

const res = await fetch('https://api.weavz.io/api/v1/workspace-members', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer wvz_your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    workspaceId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    memberId: 'm1a2b3c4-d5e6-7890-abcd-ef1234567890',
    role: 'member',
  }),
})
const data = await res.json()

python

res = httpx.post(
    "https://api.weavz.io/api/v1/workspace-members",
    headers={"Authorization": "Bearer wvz_your_api_key"},
    json={
        "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "memberId": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
        "role": "member",
    },
)
data = res.json()

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	Missing required fields
`409`	`DUPLICATE`	Member is already in this workspace

DELETE/api/v1/workspace-members/:id

Remove a member from a workspace.

Path Parameters

Field	Type	Description
`id`	string (uuid)	Workspace member ID

Response

json

{
  "deleted": true,
  "id": "pm1a2b3c-d5e6-7890-abcd-ef1234567890"
}

Example

bash

curl -X DELETE https://api.weavz.io/api/v1/workspace-members/pm1a2b3c-d5e6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer wvz_your_api_key"

typescript

await client.projectMembers.delete('pm1a2b3c-d5e6-7890-abcd-ef1234567890')

python

client.workspace_members.delete("pm1a2b3c-d5e6-7890-abcd-ef1234567890")

typescript

const res = await fetch('https://api.weavz.io/api/v1/workspace-members/pm1a2b3c-d5e6-7890-abcd-ef1234567890', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer wvz_your_api_key' },
})
const data = await res.json()

python

res = httpx.delete(
    "https://api.weavz.io/api/v1/workspace-members/pm1a2b3c-d5e6-7890-abcd-ef1234567890",
    headers={"Authorization": "Bearer wvz_your_api_key"},
)
data = res.json()

Errors

Status	Code	Description
`404`	`NOT_FOUND`	Workspace member not found