---
updatedAt: 2026-05-04T20:47:50.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# Get program import record

Get a detailed program import record, including the import steps and their statuses.


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Platform setup - Programs",
    "description": "Endpoints to handle Programs",
    "version": "v1.0",
    "contact": {
      "name": "Pismo Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Export and import",
      "description": "Export and import programs"
    }
  ],
  "components": {
    "parameters": {
      "ProgramImportIdPath": {
        "description": "Program import ID",
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64"
        },
        "example": 12345
      }
    },
    "schemas": {
      "handler.HTTPError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Bad request code",
            "example": "EOA0017"
          },
          "message": {
            "type": "string",
            "description": "Bad request response",
            "example": "Bad Request"
          }
        }
      },
      "ImportExportStepName": {
        "type": "string",
        "description": "Program export step name\n\nSteps per [program type](https://developers.pismo.io/pismo-docs/docs/program-types): \n\nKey: FBC = Full balance (FB) credit, ZBC = Zero balance (ZB) credit, FBD = FB debit, ZBD = ZB debit, FBPP = FB pre-paid, ZBPP= ZB pre-paid, Corp = Corporate\n\n| Step | FBC | ZBC | FBD | ZBD | FBPP | ZBPP| Corp |\n| ------------------------------|---|---|---|---|---|---|---|\n| `PROGRAM` | X | X | X | X | X | X | X |\n| `DUEDATES` | X |  |  |  |  |  |  |\n| `CHANNELS` | X | X | X | X | X | X |  |\n| `PROGRAMS_PARAMETERS` | X | X | X | X | X | X | X |\n| `TRANSACTIONS_CATEGORIES` | X |  |  |  |  |  |  |\n| `PROGRAMS_TRANSACTION_TYPES` | X |  |  |  |  |  |  |\n| `ORGS_OPERATIONS` | X |  | X |  | X |  | X |\n| `NETWORK_ACCEPTANCES` | X | X |  |  |  |  |  |\n",
        "enum": [
          "PROGRAM",
          "DUEDATES",
          "CHANNELS",
          "PROGRAMS_PARAMETERS",
          "TRANSACTIONS_CATEGORIES",
          "PROGRAMS_TRANSACTION_TYPES",
          "ORGS_OPERATIONS",
          "NETWORK_ACCEPTANCES"
        ],
        "maxLength": 50,
        "example": "PROGRAM"
      },
      "ImportFileUrl": {
        "type": "string",
        "description": "File URL for downloading the import. Contains part of the path and JSON file name.",
        "example": "https://programs-api.s3.amazonaws.com/TENANT/import/file.json"
      },
      "ImportFinishedAt": {
        "type": "string",
        "description": "When program import finished. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2021-09-22T15:45:00Z"
      },
      "ImportStartedAt": {
        "type": "string",
        "description": "Program import start datetime. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2021-09-22T15:00:00Z"
      },
      "ImportStepDetails": {
        "type": "string",
        "description": "Program import step details",
        "example": "Import step details"
      },
      "ImportStepID": {
        "type": "integer",
        "format": "int64",
        "description": "Program import step ID",
        "example": 12
      },
      "ImportStepOrder": {
        "type": "integer",
        "format": "int32",
        "description": "Program import step order. For example, `1` = first step, `2`  = second, and so on.",
        "example": 1
      },
      "ImportStepStatus": {
        "type": "string",
        "description": "Program import step status",
        "enum": [
          "PENDING",
          "PROCESS",
          "SUCCESS",
          "ERROR"
        ],
        "example": "SUCCESS"
      },
      "ProgramID": {
        "type": "integer",
        "format": "int64",
        "description": "Program ID",
        "example": 12345
      },
      "ProgramImporterDetails": {
        "type": "string",
        "description": "Program importer details",
        "example": "Import process details"
      },
      "ProgramImporterStatus": {
        "type": "string",
        "description": "Program import status",
        "enum": [
          "PENDING",
          "PROCESS",
          "SUCCESS",
          "ERROR"
        ],
        "example": "SUCCESS"
      },
      "ProgramImportID": {
        "type": "integer",
        "format": "int64",
        "description": "Program import ID",
        "example": 1234
      },
      "ProgramImportStep": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/ImportStepID"
          },
          "name": {
            "$ref": "#/components/schemas/ImportExportStepName"
          },
          "order": {
            "$ref": "#/components/schemas/ImportStepOrder"
          },
          "status": {
            "$ref": "#/components/schemas/ImportStepStatus"
          },
          "details": {
            "$ref": "#/components/schemas/ImportStepDetails"
          },
          "started_at": {
            "$ref": "#/components/schemas/StepStartedAt"
          },
          "finished_at": {
            "$ref": "#/components/schemas/StepFinishedAt"
          },
          "deleted_at": {
            "$ref": "#/components/schemas/StepDeletedAt"
          }
        }
      },
      "ProgramImportWithStepResponse": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/ProgramImportID"
          },
          "program_id": {
            "$ref": "#/components/schemas/ProgramID"
          },
          "status": {
            "$ref": "#/components/schemas/ProgramImporterStatus"
          },
          "file_url": {
            "$ref": "#/components/schemas/ImportFileUrl"
          },
          "details": {
            "$ref": "#/components/schemas/ProgramImporterDetails"
          },
          "started_at": {
            "$ref": "#/components/schemas/ImportStartedAt"
          },
          "finished_at": {
            "$ref": "#/components/schemas/ImportFinishedAt"
          },
          "program_import_steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProgramImportStep"
            },
            "description": "Program import process steps"
          }
        }
      },
      "StepDeletedAt": {
        "type": "string",
        "description": "Step deletion datetime. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2021-09-23T10:10:25Z"
      },
      "StepFinishedAt": {
        "type": "string",
        "description": "Step completion datetime. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2021-09-23T10:15:45Z"
      },
      "StepStartedAt": {
        "type": "string",
        "description": "Step start datetime. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2021-09-23T10:05:00Z"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/handler.HTTPError"
            }
          }
        }
      }
    },
    "examples": {
      "GenericError2Response": {
        "value": {
          "code": "EOA0016",
          "message": "Something went wrong, please try again later"
        }
      },
      "GenericErrorResponse": {
        "value": {
          "code": "EOA0015",
          "message": "Something went wrong, please try again later"
        }
      },
      "ProgramImportNotFoundResponse": {
        "value": {
          "code": "EOA0091",
          "message": "Program import xxx not found"
        }
      },
      "ProgramImportStepsNotFoundResponse": {
        "value": {
          "code": "EOA0092",
          "message": "Steps for program import xxx not found"
        }
      }
    },
    "securitySchemes": {
      "S2SAuthentication": {
        "type": "http",
        "scheme": "bearer",
        "description": "All requests must be previoulsy authenticated."
      }
    }
  },
  "security": [
    {
      "S2SAuthentication": []
    }
  ],
  "paths": {
    "/programs/v1/programs/import/{id}": {
      "get": {
        "summary": "Get program import record",
        "description": "Get a detailed program import record, including the import steps and their statuses.\n",
        "operationId": "getProgramImportRecord",
        "tags": [
          "Export and import"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ProgramImportIdPath"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProgramImportWithStepResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/handler.HTTPError"
                },
                "examples": {
                  "program-import-not-found": {
                    "$ref": "#/components/examples/ProgramImportNotFoundResponse"
                  },
                  "program-import-steps-not-found": {
                    "$ref": "#/components/examples/ProgramImportStepsNotFoundResponse"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/handler.HTTPError"
                },
                "examples": {
                  "generic-error": {
                    "$ref": "#/components/examples/GenericErrorResponse"
                  },
                  "generic-error-2": {
                    "$ref": "#/components/examples/GenericError2Response"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```