v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Export and import

List imported programs

Get your organization's imported programs in a paginated list.

The org ID is parsed from the access token.

get/programs/v1/programs/import

Query parameters

pageinteger
Example:1

Page number

perPageinteger
Example:15

Items per page

order'ASC' | 'DESC'

Order to return items: ASC = ascending order, DESC = descending. Default is DESC.

orderBy'ID' | 'NAME'
Example:ID

Sort by ID or NAME. Default = ID.

textstring

Filter items with provided text in the program name or the base program name.

statusstring

Program status. Possible values are PENDING, PROCESS, SUCCESS, and/or ERROR. Use , as separator.

userstring

User filter

begin_datestring required
Example:2025-01-01

Beginning date filter, format = yyyy-mm-dd

end_datestring required
Example:2025-01-30

End date filter, format = yyyy-mm-dd

Response

OK

current_pageinteger

Current page number

pagesinteger

Number of pages

per_pageinteger

Maximum number of items per page

total_itemsinteger

Total number of items

Example response

{
  "current_page": 1,
  "items": [
    {
      "id": 1,
      "program_id": 1010,
      "program_name": "Digital wallet program",
      "program_type_id": 1,
      "status": "SUCCESS",
      "details": "Details of program export 484",
      "file_url": "export/TN-00001/484/export.json",
      "started_at": "2023-07-10 15:30:14",
      "finished_at": "2023-07-10 18:31:18",
      "user": "example@pismo.io"
    }
  ],
  "pages": 10,
  "per_page": 15,
  "total_items": 100
}