---
title: List Groups
slug: list-groups
docTags: 
createdAt: 2023-11-07T15:25:31.944Z
---

{
  "id": "dxXjBA7yJtk5bcIuFfdVq",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://example.com/scim/v2/Groups",
    "servers": [
      {
        "url": "https://example.com/scim/v2/Groups",
        "description": "Jobylon Staging"
      }
    ],
    "name": "List Groups",
    "description": "<p>List Group objects. Search is available using the  <code>filter</code> query parameter.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "filter",
          "type": "string",
          "description": "<p>Filter results using <a href=\"https://bookstack.soffid.com/books/scim/page/scim-query-syntax\" target=\"_blank\">SCIM query syntax</a></p>"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "qDkPPwFtr47X3C0DIvej9",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://example.com/scim/v2/Groups \\\n     --header 'accept: application/json'"
        },
        {
          "id": "H-WGz7EQOTMO9NEDe5Fus",
          "language": "go",
          "label": "Go",
          "code": "package main\n\nimport (\n   \"fmt\"\n   \"net/http\"\n   \"io/ioutil\"\n)\n\nfunc main() {\n\n   url := \"https://example.com/scim/v2/Groups\"\n   method := \"GET\"\n\n   client := &http.Client {\n   }\n   req, err := http.NewRequest(method, url, nil)\n\n   if err != nil {\n      fmt.Println(err)\n      return\n   }\n   req.Header.Add(\"accept\", \"application/json\")\n   req.Header.Add(\"content-type\", \"application/json\")\n\n   res, err := client.Do(req)\n   if err != nil {\n      fmt.Println(err)\n      return\n   }\n   defer res.Body.Close()\n\n   body, err := ioutil.ReadAll(res.Body)\n   if err != nil {\n      fmt.Println(err)\n      return\n   }\n   fmt.Println(string(body))\n}"
        },
        {
          "id": "saEhtPwWlC6arwx0rPuoC",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://example.com/scim/v2/Groups\"\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"
        },
        {
          "id": "cVcFaZsz21TWkzE0BGKyo",
          "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(\"https://example.com/scim/v2/Groups\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "rklUmL89tBeCzHSIk1ivT",
          "language": "java",
          "label": "Java",
          "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n   .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n   .url(\"https://example.com/scim/v2/Groups\")\n   .method(\"GET\", body)\n   .addHeader(\"accept\", \"application/json\")\n   .addHeader(\"content-type\", \"application/json\")\n   .build();\nResponse response = client.newCall(request).execute();"
        }
      ],
      "selectedLanguageId": "qDkPPwFtr47X3C0DIvej9"
    },
    "results": {
      "languages": [
        {
          "id": "4mIJelJC8fhM7jweyYaz4",
          "language": "200",
          "code": "// OK\n"
        }
      ],
      "selectedLanguageId": "4mIJelJC8fhM7jweyYaz4"
    }
  },
  "children": [
    {
      "id": "5z0gsw08kYaWVItpXIKa6",
      "type": "paragraph",
      "children": [
        {
          "text": "List Group objects. Search is available using the  "
        },
        {
          "text": "filter",
          "highlight": true
        },
        {
          "text": " query parameter."
        }
      ]
    }
  ]
}