GET /v1/directories
- Scope
directories:read- Auth
- Secret key (
sk_…) - Since
- 1.0
Query parameters
Section titled “Query parameters”limitintegermin 1 · max 100 · default
20
Cursor from next_cursor.afterstringbeforestringorganizationstring
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 A page of results. DirectoryList
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X GET \ "https://api.ohauthcat.com/v1/directories" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"const response = await fetch("https://api.ohauthcat.com/v1/directories", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/directories", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "object": "list", "data": [ { "google_oauth_available": true, "bamboohr_oauth_available": true, "gusto_oauth_available": true, "id": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "directory", "legacy_ids": { "workos": "org_01H8ZQ4M7K2X8V3N5B6C1D0E9F" }, "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "name": "Acme Corp", "provider": "okta", "state": "awaiting_first_request", "scim_base_url": "https://app.acme.com/callback", "created_at": "2026-01-15T09:30:00Z" } ], "has_more": true, "next_cursor": "cur_01J9Z3K5V7W8X9Y0Z1A2B3C4D5"}