# List compatible directory_groups

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-get">GET</span> <code>/compat/workos/directory_groups</code></p>

Exactly one of directory or user is required. Supplying neither or both, or both before and after, returns 422.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>directory_data:read</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Query parameters

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">limit</code> <span class="api-field__type">integer</span></p>

<p class="api-field__chips">min 1 · max 100 · default <code>10</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">before</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">min length 1 · max length 2048</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">after</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">min length 1 · max length 2048</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">order</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">one of <code>asc</code>, <code>desc</code> · default <code>&quot;desc&quot;</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">directory</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">min length 1 · max length 2048</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">user</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">min length 1 · max length 2048</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">WorkOSDirectoryGroupList</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>A secret API key is required. <span class="api-field__type">WorkOSDsyncError</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>The secret key lacks the required scope. <span class="api-field__type">WorkOSDsyncError</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">404</span> <span>The resource is absent or compatibility is disabled. <span class="api-field__type">WorkOSDsyncError</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">422</span> <span>Invalid compatibility filter or cursor. <span class="api-field__type">WorkOSDsyncError</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>WorkOS compatibility refusal; invalid filters and cursors use 422. <span class="api-field__type">WorkOSDsyncError</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X GET \
  "https://api.ohauthcat.com/compat/workos/directory_groups" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY"
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/compat/workos/directory_groups",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    },
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.get(
    "https://api.ohauthcat.com/compat/workos/directory_groups",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
)
data = response.json()
```

```json title="Response 200" wrap
{
  "object": "list",
  "data": [
    {
      "id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      "object": "directory_group",
      "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      "directory_id": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      "idp_id": "0oa1b2c3d4E5F6g7h8i9",
      "name": "Acme Corp",
      "created_at": "2026-01-15T09:30:00Z",
      "updated_at": "2026-01-15T09:30:00Z"
    }
  ],
  "list_metadata": {
    "before": "cur_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    "after": "cur_01J9Z3K5V7W8X9Y0Z1A2B3C4D5"
  }
}
```

</div>
</div>
