Users

Use the Users API to manage who has access to a workspace and what they can do. Each member is assigned a role that controls their permissions within that workspace.

---

List Members

Returns all members of a workspace.

curl https://api.moonshadow.dev/v1/workspaces/ws_abc123/members \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id · string · required

The workspace ID, e.g. ws_abc123.

Response

data · array

Array of member objects.

data[].user_id · string

Unique user identifier, e.g. usr_xyz789.

data[].email · string

Email address of the member.

data[].role · string

Role in the workspace: owner, admin, or member.

data[].joined_at · string

ISO 8601 timestamp of when the user joined the workspace.

{
  "data": [
    {
      "user_id": "usr_xyz789",
      "email": "[e-mail]",
      "role": "owner",
      "joined_at": "2024-01-15T10:30:00Z"
    },
    {
      "user_id": "usr_pqr012",
      "email": "[e-mail]",
      "role": "member",
      "joined_at": "2024-02-10T09:00:00Z"
    }
  ]
}

---

Invite a Member

Invites a new user to join a workspace. An invitation email is sent if the user does not already have an account.

curl -X POST https://api.moonshadow.dev/v1/workspaces/ws_abc123/members/invite \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[e-mail]",
    "role": "admin"
  }'

Path Parameters

id · string · required

The workspace ID to invite the member into.

Request Body

email · string · required

Email address of the person to invite.

role · string · default: "member"

Role to assign: owner, admin, or member.

Response

{
  "user_id": "usr_stu345",
  "email": "[e-mail]",
  "role": "admin",
  "status": "invited",
  "invited_at": "2024-06-10T17:30:00Z"
}

---

Update Member Role

Changes the role of an existing workspace member.

curl -X PATCH https://api.moonshadow.dev/v1/workspaces/ws_abc123/members/usr_stu345 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role": "member"}'

Path Parameters

id · string · required

The workspace ID.

userId · string · required

The user ID of the member to update.

Request Body

role · string · required

New role for the member: owner, admin, or member.

Response

{
  "user_id": "usr_stu345",
  "email": "[e-mail]",
  "role": "member",
  "updated_at": "2024-06-10T18:00:00Z"
}

A workspace must always have at least one owner. You cannot change the role of the sole owner.

---

Remove a Member

Removes a member from a workspace.

curl -X DELETE https://api.moonshadow.dev/v1/workspaces/ws_abc123/members/usr_stu345 \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

id · string · required

The workspace ID.

userId · string · required

The user ID of the member to remove.

Response

Returns 204 No Content on success.

Removing a member immediately revokes their access to the workspace and all associated integrations. This action cannot be undone, but you can re-invite the user later.