---
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.
# List exported programs
Get your organization's exported programs in a paginated list. The organization ID is parsed from the token.
# 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": {
"BeginDateQuery": {
"name": "beginDate",
"in": "query",
"description": "Return programs exported on or after this date. Format = yyyy-mm-ddThh:mm:ss.",
"schema": {
"type": "string"
},
"example": "2021-09-22T15:00:00Z"
},
"EndDateQuery": {
"name": "endDate",
"in": "query",
"description": "Return programs exported on or before this date. Format = yyyy-mm-ddThh:mm:ss.",
"schema": {
"type": "string"
},
"example": "2021-09-22T15:00:00Z"
},
"OrderByQuery": {
"name": "orderBy",
"in": "query",
"description": "Field to sort on. Default = `ID`.",
"schema": {
"type": "string",
"enum": [
"ID",
"NAME"
]
},
"example": "NAME"
},
"OrderQuery": {
"name": "order",
"in": "query",
"description": "Sort order. Default = `ASC`.",
"schema": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"example": "DESC"
},
"PageQuery": {
"name": "page",
"in": "query",
"description": "Current page number. Must be greater than `0`. Default = `1`.",
"schema": {
"type": "integer",
"format": "int32"
},
"example": 2
},
"PerPageQuery": {
"name": "perPage",
"in": "query",
"description": "Maximum number of items per page. Must be greater than `0`. Default = `10`.",
"schema": {
"type": "integer",
"format": "int32"
},
"example": 20
},
"ProgramStatusQuery2": {
"name": "status",
"in": "query",
"description": "Program status. Possible values are `PENDING`, `PROCESS`, `SUCCESS`, and/or `ERROR`. Use `,` as separator.",
"schema": {
"type": "string"
},
"example": "PENDING"
},
"TextQuery": {
"name": "text",
"in": "query",
"description": "Filter items with provided text in the program name or the base program name.",
"schema": {
"type": "string",
"maxLength": 50
},
"example": "Pismo test"
},
"UserQuery": {
"name": "user",
"in": "query",
"description": "User filter",
"schema": {
"type": "string",
"maxLength": 255
},
"example": "Test User"
}
},
"schemas": {
"CurrentPage": {
"type": "integer",
"format": "int32",
"description": "Current page",
"example": 1
},
"ExportCreatedAt": {
"type": "string",
"description": "Program export creation datetime. Format = yyyy-mm-ddThh:mm:ss.",
"example": "2023-07-10 15:30:14"
},
"ExporterDetails": {
"type": "string",
"description": "Program exporter details",
"example": "Details of program export 484"
},
"ExportFileUrl": {
"type": "string",
"description": "File URL for download export",
"example": "export/TN-00001/484/export.json"
},
"ExportFinishedAt": {
"type": "string",
"description": "Datetime when program export finished. Format = yyyy-mm-ddThh:mm:ss.",
"example": "2023-07-10 18:31:18"
},
"ExportUser": {
"type": "string",
"description": "User who created the export's email address",
"example": "example@pismo.io"
},
"handler.HTTPError": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Bad request code",
"example": "EOA0017"
},
"message": {
"type": "string",
"description": "Bad request response",
"example": "Bad Request"
}
}
},
"Pages": {
"type": "integer",
"format": "int32",
"description": "Number of pages",
"example": 1
},
"PerPage": {
"type": "integer",
"format": "int32",
"description": "Maximum items per page",
"example": 10
},
"ProgramExporterStatus": {
"type": "string",
"description": "Program exporter status",
"enum": [
"PENDING",
"PROCESS",
"SUCCESS",
"ERROR"
],
"example": "SUCCESS"
},
"ProgramExportID": {
"type": "integer",
"format": "int64",
"description": "Program export ID",
"example": 1
},
"ProgramExportPage": {
"type": "object",
"properties": {
"current_page": {
"$ref": "#/components/schemas/CurrentPage"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgramExport"
}
},
"pages": {
"$ref": "#/components/schemas/Pages"
},
"per_page": {
"$ref": "#/components/schemas/PerPage"
},
"total_items": {
"$ref": "#/components/schemas/TotalItems"
}
}
},
"ProgramID": {
"type": "integer",
"format": "int64",
"description": "Program ID",
"example": 12345
},
"ProgramName": {
"type": "string",
"description": "Program name",
"maxLength": 50,
"example": "Acme debit program"
},
"ProgramExport": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/ProgramExportID"
},
"program_id": {
"$ref": "#/components/schemas/ProgramID"
},
"program_name": {
"$ref": "#/components/schemas/ProgramName"
},
"program_type_id": {
"$ref": "#/components/schemas/ProgramTypeID"
},
"status": {
"$ref": "#/components/schemas/ProgramExporterStatus"
},
"details": {
"$ref": "#/components/schemas/ExporterDetails"
},
"file_url": {
"$ref": "#/components/schemas/ExportFileUrl"
},
"started_at": {
"$ref": "#/components/schemas/ExportCreatedAt"
},
"finished_at": {
"$ref": "#/components/schemas/ExportFinishedAt"
},
"user": {
"$ref": "#/components/schemas/ExportUser"
}
}
},
"ProgramTypeID": {
"type": "integer",
"format": "int64",
"description": "Program type ID:
\n\n `1` = `CREDITO`
\n `2` = `PRE-PAGO`
\n `3` = `DEBITO`
\n `5` = `MERCHANT`
\n `7` = `CREDITO ZERO-BALANCE`
\n `8` = `PRE-PAGO ZERO-BALANCE`
\n `9` = `DEBITO ZERO-BALANCE`
\n `11` =` CURRENT ACCOUNTS`
\n `12` = `INTERNAL ACCOUNTS`
\n `13` = `CORRESPONDENT ACCOUNTS`
\n `15` = `VOUCHER`
\n\nFor more information, refer to [Program types](https://developers.pismo.io/pismo-docs/docs/program-types).\n",
"example": 1
},
"TotalItems": {
"type": "integer",
"format": "int32",
"description": "Total number of items",
"example": 3
}
},
"responses": {
"400BadRequest": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/handler.HTTPError"
}
}
}
}
},
"securitySchemes": {
"S2SAuthentication": {
"type": "http",
"scheme": "bearer",
"description": "All requests must be previoulsy authenticated."
}
}
},
"security": [
{
"S2SAuthentication": []
}
],
"paths": {
"/programs/v1/programs/export": {
"get": {
"summary": "List exported programs",
"description": "Get your organization's exported programs in a paginated list. The organization ID is parsed from the token.\n",
"operationId": "getProgramExport",
"tags": [
"Export and import"
],
"parameters": [
{
"$ref": "#/components/parameters/PageQuery"
},
{
"$ref": "#/components/parameters/PerPageQuery"
},
{
"$ref": "#/components/parameters/OrderQuery"
},
{
"$ref": "#/components/parameters/OrderByQuery"
},
{
"$ref": "#/components/parameters/TextQuery"
},
{
"$ref": "#/components/parameters/ProgramStatusQuery2"
},
{
"$ref": "#/components/parameters/UserQuery"
},
{
"$ref": "#/components/parameters/BeginDateQuery"
},
{
"$ref": "#/components/parameters/EndDateQuery"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgramExportPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequest"
}
}
}
}
}
}
```