Skip to content
Dashboard
Theme
Theme

Get compatible directories object

GET /compat/workos/directories/{id}: Get compatible directories object.

View Markdown

GET /compat/workos/directories/{id}

Scope
directories:read
Auth
Secret key (sk_…)
Since
1.0
  • id string Required

    min length 1 · max length 256

  • 200 OK WorkOSDirectory
  • 401 A secret API key is required. WorkOSDsyncError
  • 403 The secret key lacks the required scope. WorkOSDsyncError
  • 404 The resource is absent or compatibility is disabled. WorkOSDsyncError
  • 422 Invalid compatibility filter or cursor. WorkOSDsyncError
  • default WorkOS compatibility refusal; invalid filters and cursors use 422. WorkOSDsyncError

Errors share one shape; see the error code catalogue.

curl -X GET \
"https://api.ohauthcat.com/compat/workos/directories/01J9Z3K5V7W8X9Y0Z1A2B3C4D5" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "directory",
"organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"type": "default",
"state": "validating",
"name": "Acme Corp",
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z"
}