Skip to content
Dashboard
Theme
Theme

Retrieve a pulled directory source

GET /v1/directories/{dir}/source: Retrieve a pulled directory source.

View Markdown

GET /v1/directories/{dir}/source

The poll state of a directory whose provider is a pulled source (bamboohr, rippling_hris, google_admin_sdk, sftp_csv, workday, hibob, personio, gusto). Credentials are never returned. Not found until credentials are saved.

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

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Errors share one shape; see the error code catalogue.

curl -X GET \
"https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"object": "directory_source",
"directory_id": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"kind": "bamboohr",
"next_sync_at": "2026-01-15T09:30:00Z",
"last_synced_at": "2026-01-15T09:30:00Z",
"last_error": "saml_signature_invalid",
"failures": 1,
"sync_interval_minutes": 1,
"last_result": {},
"last_skipped": [
{
"external_id": "acme-123",
"name": "Acme Corp",
"reason": "no_id"
}
]
}