> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List of Workspace Members

> This endpoint returns all worksapce member details

#### API Response Description:

<ResponseField name="status" type="boolean">
  Indicates the success or failure of the workspace members retrieval. In this case,
  true signifies a successful operation.
</ResponseField>

<ResponseField name="message" type="string">
  Provides a human-readable message accompanying the response. In this instance,
  it confirms the successful retrieval of the workspace members with the message
  "Workspace members fetched successfully!"
</ResponseField>

<ResponseField name="data" type="array_object">
  An array containing details of the available workspace members. For each member
  in the data array:

  <Expandable title="data">
    <ResponseField name="workspaceId" type="string">
      The unique identifier of the workspace to which the member belongs.
    </ResponseField>

    <ResponseField name="userId" type="string">
      The unique identifier of the member, allowing for precise referencing.
    </ResponseField>

    <ResponseField name="avatar" type="string">
      The URL of the member's profile picture, if available.
    </ResponseField>

    <ResponseField name="fullName" type="string">
      The full name of the member, providing a clear identification.
    </ResponseField>

    <ResponseField name="email" type="string">
      The email address of the member.
    </ResponseField>

    <ResponseField name="phone" type="string">
      The phone number of the member.
    </ResponseField>

    <ResponseField name="userType" type="string">
      The role of the member in the workspace, such as OWNER, ADMIN, or MEMBER.
    </ResponseField>

    <ResponseField name="userStatus" type="string">
      The status of the member, such as INVITED, SUSPENDED, or ACTIVE.
    </ResponseField>

    <ResponseField name="timezone" type="string">
      The timezone of the member.
    </ResponseField>

    <ResponseField name="deactivated" type="boolean">
      Indicates whether the member is deactivated or suspended (true/false).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "status": true,
    "message": "Workspace members fetched successfully!",
    "data": [
      {
        "workspaceId": "652e5068c33fe13b6ba00fd7",
        "userId": "652e5068c33fe1cd1da00fda",
        "avatar": "",
        "fullName": "User Name",
        "email": "user@zixflow.com",
        "phone": "9190909090",
        "userType": "OWNER",
        "userStatus": "ACTIVE",
        "timezone": "Asia/Kolkata",
        "deactivated": false
      }
    ]
  }
  ```

  ```json 401-Unauthorised theme={null}
  {
    "status": false,
    "message": "No token provided"
  }
  ```
</ResponseExample>
