Skip to content
Dashboard
Theme
Theme

Retrieve an import plan

GET /v1/imports/{imp}: Retrieve an import plan.

View Markdown

GET /v1/imports/{imp}

Scope
imports:read
Auth
Secret key (sk_…)
Since
1.0
  • imp 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/imports/imp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"id": "imp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "import",
"source": "polis",
"state": "planning",
"plan": {
"organizations": [
{
"organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"lever": "A",
"routing": "legacy",
"blockers": [
"example_blocker"
],
"legacy_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"name": "Acme Corp",
"state": "pending",
"error_code": "saml_signature_invalid",
"refused": "example_refused",
"items": [
{}
],
"imported_at": "2026-01-15T09:30:00Z",
"switched_at": "2026-01-15T09:30:00Z",
"rolled_back_at": "2026-01-15T09:30:00Z"
}
],
"summary": {
"create": 1,
"draft": 1,
"skip": 1,
"users": 1,
"groups": 1
},
"source_skipped": [
{
"kind": "default",
"legacy_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"reason": "Primary SSO connection for Acme Corp."
}
],
"custom_hostnames": [
{
"hostname": "acme.com",
"type": "default"
}
]
},
"bundle_source": "polis",
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z",
"completed_at": "2026-01-15T09:30:00Z"
}