---
title: List Workers
slug: telemetry-pipeline/list-workers
docTags: 
createdAt: 2023-12-26T14:37:58.070Z
---

{
  "id": "ZielHQbVWL2eurM8ffj62",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "{{url}}/api/portal/external/worker",
    "servers": [
      {
        "url": "{{url}}/api/portal/external/worker",
        "description": "Development environment"
      }
    ],
    "name": "List Workers",
    "description": "This API lists the available workers in the system.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "cookieAuth",
          "name": "SESSION",
          "kind": "optional",
          "type": "apiKey",
          "in": "cookie"
        },
        {
          "id": "tokenAuth",
          "name": "X-XSRF-TOKEN",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "SzRM_ENzEnIF1is8xquC0",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url {{url}}/api/portal/external/worker \\\n     --header 'accept: application/json'"
        },
        {
          "id": "Kwc3RPMuyCew_ICBxSb31",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"{{url}}/api/portal/external/worker\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "OVLISh5tBwwyhMHDE1wL1",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"{{url}}/api/portal/external/worker\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "Ocn8J-1mtfLYW9BPNgmqZ",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"{{url}}/api/portal/external/worker\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "SzRM_ENzEnIF1is8xquC0"
    },
    "results": {
      "languages": [
        {
          "id": "HCJfehLexmQtQUUs6ec1P",
          "language": "200",
          "code": "// OK\n"
        }
      ],
      "selectedLanguageId": "HCJfehLexmQtQUUs6ec1P"
    }
  },
  "children": [
    {
      "id": "u8hBIKlpiPyeLl7L1I52s",
      "type": "paragraph",
      "children": [
        {
          "text": "This API lists the available workers in the system."
        }
      ]
    }
  ]
}