Members

Members

@toothfairyai/sdk@latest…

Accessed via client.members.

Methods

Method	HTTP	Endpoint
delete	DELETE	DELETE /member/delete/{id}
get	GET	GET /member/get/{id}
list	GET	GET /member/list
update	POST	POST /member/update

delete

async delete(id: string): Promise<

Endpoint: DELETE /member/delete/{id} · API service

Response fields

Field	Type	Description
success	boolean	Operation success status
data	object	Response data
message	string	Optional success message

Example

const result = await client.members.delete('agent-id');

get

async get(id: string)

Endpoint: GET /member/get/{id} · API service

Response fields

Field	Type	Description
id	string	Unique identifier for the member
userID	string	User identifier
workspaceid	string	Unique workspace identifier in UUID v4 format
role	string	Member role in the workspace

Allowed: admin, member, viewer | | status | string | Member status

Allowed: active, pending, suspended | | createdBy | string | User ID who added the member | | updatedBy | string | User ID who last updated the member |

Example

const result = await client.members.get('agent-id');

list

async list(limit?: number)

Endpoint: GET /member/list · API service

Example

const result = await client.members.list();

update

async update(data: MemberUpdateData)

Endpoint: POST /member/update · API service

Request fields

Field	Type	Required	Description
id	string	yes	Member ID to update
userID	string	yes	User identifier
workspaceid	string	yes	Unique workspace identifier in UUID v4 format
role	string	yes	Updated member role

Allowed: admin, member, viewer | | status | string | no | Updated member status

Allowed: active, pending, suspended |

Response

Returns the Member object — fields documented in the get section above.

Example

const result = await client.members.update(…);