---
title: List workspace members
slug: mihai-tests/list-workspace-members
createdAt: 2025-01-22T07:25:18.837Z
---

{
  "id": "G-PfsRVlF6P5cNh4NuAJh",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.app.kognic.com/v1/workspace-members",
    "servers": [],
    "name": "List workspace members",
    "description": "<p>Add description here with link to <a href=\"https://docs.kognic.com/api-guide/data-requirements\" target=\"_blank\">our own dev docs</a></p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "required",
          "name": "workspaceId",
          "type": "string<uuid>",
          "example": "123e4567-e89",
          "description": "Describe the workspaceId parameter here"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Enveloped_Seq_WorkspaceMemberDto",
            "schema": [
              {
                "name": "data",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/components/schemas/WorkspaceMemberDto",
                "customType": "WorkspaceMemberDto[]",
                "schema": [
                  {
                    "name": "allowedToUpdateOrRemove",
                    "kind": "required",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "string<uuid>",
                    "example": ""
                  },
                  {
                    "name": "roles",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "modelRef": "#/components/schemas/WorkspaceRoleDto",
                    "customType": "WorkspaceRoleDto[]",
                    "schema": []
                  },
                  {
                    "name": "user",
                    "kind": "required",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/components/schemas/UserDto",
                    "customType": "UserDto",
                    "schema": [
                      {
                        "name": "email",
                        "kind": "required",
                        "type": "string",
                        "example": ""
                      },
                      {
                        "name": "firstName",
                        "kind": "required",
                        "type": "string",
                        "example": ""
                      },
                      {
                        "name": "id",
                        "kind": "required",
                        "type": "integer<int64>",
                        "example": 0
                      },
                      {
                        "name": "lastName",
                        "kind": "required",
                        "type": "string",
                        "example": ""
                      },
                      {
                        "name": "organizationId",
                        "kind": "required",
                        "type": "integer<int64>",
                        "example": 0
                      },
                      {
                        "name": "organizationName",
                        "kind": "required",
                        "type": "string",
                        "example": ""
                      }
                    ]
                  },
                  {
                    "name": "workspaceId",
                    "kind": "required",
                    "type": "string<uuid>",
                    "example": ""
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/Enveloped_Seq_WorkspaceMemberDto",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Bad request",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "BadRequest",
            "schema": [
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "string",
                "example": ""
              },
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/BadRequest",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "Unauthorized",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Unauthorized",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/Unauthorized",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "403",
        "description": "Forbidden",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "Forbidden",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/Forbidden",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "Not found",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "NotFound",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/NotFound",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "413",
        "description": "Payload too large",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "PayloadTooLarge",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/PayloadTooLarge",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "500",
        "description": "Internal server error",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "InternalServerError",
            "schema": [
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "example": ""
              }
            ],
            "modelRef": "#/components/schemas/InternalServerError",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "zUFzrPStSEBDKqS6hC9R2",
          "language": "python",
          "code": "import kognic-auth\n //this is a comment\n import requests\n\nresponse = requests.get(\"https://api.app.kognic.com/v1/workspace-members\", headers={\"accept\": \"application/json\"})\nprint(response.json())"
        }
      ],
      "selectedLanguageId": "zUFzrPStSEBDKqS6hC9R2"
    },
    "hasXCodeSamples": true,
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "{\n  \"data\": [\n    {\n      \"allowedToUpdateOrRemove\": false,\n      \"id\": \"\",\n      \"roles\": [\n        \"\"\n      ],\n      \"user\": {\n        \"email\": \"\",\n        \"firstName\": \"\",\n        \"id\": \"\",\n        \"lastName\": \"\",\n        \"organizationId\": \"\",\n        \"organizationName\": \"\"\n      },\n      \"workspaceId\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// Bad request\n{\n  \"errorCode\": \"\",\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// Unauthorized\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-3-403",
          "language": "403",
          "code": "// Forbidden\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-4-404",
          "language": "404",
          "code": "// Not found\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-5-413",
          "language": "413",
          "code": "// Payload too large\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-6-500",
          "language": "500",
          "code": "// Internal server error\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "PgeorQBIuT3pvyKiI95eB",
      "type": "paragraph",
      "children": [
        {
          "text": "Add description here with link to "
        },
        {
          "id": "zg1rKXF3ee87hhNNbP3gQ",
          "type": "link",
          "data": {
            "href": "https://docs.kognic.com/api-guide/data-requirements"
          },
          "children": [
            {
              "text": "our own dev docs"
            }
          ]
        }
      ]
    }
  ]
}