List Members

Endpoint used to list members from a workspace in Toolzz Bots.

Request Example

curl --request GET \
  --url 'https://bots.toolzz.ai/api/v1/workspaces/{workspaceId}/members' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "members": [
    {
      "workspaceId": "<string>",
      "role": "<string>",
      "user": {
        "name": "<string>",
        "email": "<string>",
        "image": "<string>"
      }
    }
  ]
}

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (must contain “Bearer” before the token)	Yes

URL Parameters (Path)

Parameter	Type	Description	Required
workspaceId	string	The unique identifier of the workspace to list members from.	Yes

---

Response description

Key	Type	Description
members	object[]	Workspace members information.
members[].workspaceId	string	The workspace unique identifier.
members[].role	string	Member role in the workspace.
members[].user	object	The user data.
members[].user.name	string	User name.
members[].user.email	string	User email.
members[].user.image	string	User profile image URL.

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request.