---
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 program parameters

Retrieves a paginated list of program parameters.

# 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": "Parameters",
      "description": "Manage program parameters"
    }
  ],
  "components": {
    "parameters": {
      "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
      },
      "ProgramParameterCategoryQuery": {
        "name": "category",
        "in": "query",
        "description": "One or more program parameter categories. Use `,` as separator. <br />\n`CREDITO` - Credit<br />\n`TAXA` - Tax<br />\n`TARIFA` -  Fee<br />\n`PARAMETRO` - Parameter<br />\n`ARQUIVOS` - Archives<br />\n`COBRANCA` - Collection<br />\n`FISCAL` - Fiscal<br />\n`FATURAMENTO` - Billing<br />\n`CARTAO` - Card<br />\n`FRAUDE` - Fraud<br />\n`TIPO DE TRANSACAO` -  Type of transaction<br />\n",
        "schema": {
          "type": "string"
        },
        "example": "CREDITO"
      },
      "ProgramIdPath2": {
        "name": "program_id",
        "in": "path",
        "description": "Program ID",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64"
        },
        "example": 12345
      },
      "ProgramNamesQuery": {
        "name": "names",
        "in": "query",
        "description": "One or more program names. Use `,` as separator.",
        "schema": {
          "type": "string"
        },
        "example": "Pismolabs, Acme Testing"
      },
      "ProgramStatusQuery": {
        "name": "status",
        "in": "query",
        "description": "Program status filter. Can be `ACTIVE` and/or `INACTIVE`. Use ',' as separator.",
        "schema": {
          "type": "string"
        },
        "example": "ACTIVE"
      },
      "ValidFromQuery": {
        "name": "validFrom",
        "in": "query",
        "description": "Return results greater than or equal to the parameter's expiration date. Format = yyyy-mm-ddThh:mm:ss.",
        "schema": {
          "type": "string"
        },
        "example": "2021-07-06T13:11:05Z"
      },
      "ValidUntilQuery": {
        "name": "validUntil",
        "in": "query",
        "description": "Return results less than or equal to the parameter expiration date. Format = yyyy-mm-ddThh:mm:ss.",
        "schema": {
          "type": "string"
        },
        "example": "2021-07-06T13:11:05Z"
      }
    },
    "schemas": {
      "AccountParameterBoolean": {
        "type": "boolean",
        "description": "Can the parameter be customized at both the account and program levels?",
        "example": false
      },
      "CurrentPage": {
        "type": "integer",
        "format": "int32",
        "description": "Current page",
        "example": 1
      },
      "FloatParameterValue": {
        "type": "number",
        "format": "float",
        "description": "Parameter value",
        "example": 1.5
      },
      "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
      },
      "ParameterID": {
        "description": "Parameter ID. Parameter IDs can change depending on the environment and, consequently, are not listed in the [program parameters reference table](https://developers.pismo.io/pismo-docs/docs/program-parameters-reference-table). Use the [List program parameters](https://developers.pismo.io/pismo-docs/reference/programparameter) endpoint to get the IDs (`parameter_id` in the response) for your program parameters.\n",
        "example": 1,
        "type": "integer",
        "format": "int64"
      },
      "PerPage": {
        "type": "integer",
        "format": "int32",
        "description": "Maximum items per page",
        "example": 10
      },
      "ProgramParameter": {
        "type": "object",
        "properties": {
          "account_parameter": {
            "$ref": "#/components/schemas/AccountParameterBoolean"
          },
          "category": {
            "$ref": "#/components/schemas/ProgramParameterCategory"
          },
          "description": {
            "$ref": "#/components/schemas/ProgramParameterDescription"
          },
          "id": {
            "$ref": "#/components/schemas/ProgramParameterID"
          },
          "parameter_id": {
            "$ref": "#/components/schemas/ParameterID"
          },
          "name": {
            "$ref": "#/components/schemas/ProgramParameterName"
          },
          "type": {
            "$ref": "#/components/schemas/ProgramParameterValueType"
          },
          "valid_from": {
            "$ref": "#/components/schemas/ValidFrom"
          },
          "valid_until": {
            "$ref": "#/components/schemas/ValidUntil"
          },
          "value": {
            "$ref": "#/components/schemas/FloatParameterValue"
          }
        }
      },
      "ProgramParameters": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/ProgramParameter"
        }
      },
      "ProgramParameterCategory": {
        "type": "string",
        "description": "Program parameter categories. When passing as a parameter, use `,` as separator. \n`CREDITO` - Credit\n`TAXA` -  Tax\n`TARIFA` -  Fee\n`PARAMETRO` -  Parameter\n`ARQUIVOS` -  Archives\n`COBRANCA` -  Collection\n`FISCAL` -  Fiscal\n`FATURAMENTO` -  Billing\n`CARTAO` -  Card\n`FRAUDE` -  Fraud\n`TIPO DE TRANSACAO` -  Type of transaction\n",
        "example": "CREDITO"
      },
      "ProgramParameterDescription": {
        "type": "string",
        "description": "Program parameter description",
        "example": "Turn the control on and off."
      },
      "ProgramParameterID": {
        "type": "integer",
        "format": "int64",
        "description": "Program parameter ID. An ID, specific to the program itself, that identifies the program's setting for a specific program parameter.\n\nFor example, suppose you have a program parameter named `CONTROL EXPIRATION CHANGES`, and its `id` is `15`. One program might set the value for that parameter like this:\n```json\n{\n  \"account_parameter\": false,\n  \"category\": \"PARAMETER\",\n  \"description\": \"Turn the control on and off.\",\n  \"id\": 2,\n  \"parameter_id\": 15,\n  \"name\": \"CONTROL EXPIRATION CHANGES\",\n  \"type\": \"DECIMAL\",\n  \"valid_from\": \"2020-01-01T00:00:00.000Z\",\n  \"valid_until\": \"2020-12-31T23:59:59.999Z\",\n  \"value\": 0\n}\n```\n\nAnother program might set the value for same program parameter like this:\n```json\n{\n  \"account_parameter\": false,\n  \"category\": \"PARAMETER\",\n  \"description\": \"Turn the control on and off.\",\n  \"id\": 4,\n  \"parameter_id\": 15,\n  \"name\": \"CONTROL EXPIRATION CHANGES\",\n  \"type\": \"DECIMAL\",\n  \"valid_from\": \"2020-02-04T00:00:00.000Z\",\n  \"valid_until\": \"2020-11-25T22:36:55.999Z\",\n  \"value\": 1\n}\n```\n\nIn both cases, `parameter_id` is `15` because the programs are setting the same program parameter - the one with `id` = `15`. However, the `id` value is different for each program, because it is used to identify that program's specific parameter setting.\n",
        "example": 1
      },
      "ProgramParameterName": {
        "type": "string",
        "maxLength": 50,
        "description": "Program parameter name.\n\nFor more information, refer to the [program parameters](https://developers.pismo.io/pismo-docs/docs/program-parameters-reference-table) reference table.\n",
        "example": "CONTROL EXPIRATION CHANGES"
      },
      "ProgramParameterPage": {
        "type": "object",
        "properties": {
          "current_page": {
            "$ref": "#/components/schemas/CurrentPage"
          },
          "items": {
            "$ref": "#/components/schemas/ProgramParameters"
          },
          "pages": {
            "$ref": "#/components/schemas/Pages"
          },
          "per_page": {
            "$ref": "#/components/schemas/PerPage"
          },
          "total_items": {
            "$ref": "#/components/schemas/TotalItems"
          }
        }
      },
      "ProgramParameterValueType": {
        "type": "string",
        "description": "Parameter value type",
        "enum": [
          "INTEGER",
          "DECIMAL",
          "PERCENTAGE"
        ],
        "example": "DECIMAL"
      },
      "TotalItems": {
        "type": "integer",
        "format": "int32",
        "description": "Total number of items",
        "example": 3
      },
      "ValidFrom": {
        "type": "string",
        "format": "date-time",
        "description": "Provided value start datetime. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2020-01-01T00:00:00.000Z"
      },
      "ValidUntil": {
        "type": "string",
        "format": "date-time",
        "description": "Provided value expiration datetime. Format = yyyy-mm-ddThh:mm:ss.",
        "example": "2020-12-31T23:59:59.999Z"
      }
    },
    "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/{program_id}/parameters": {
      "get": {
        "summary": "List program parameters",
        "description": "Retrieves a paginated list of program parameters.",
        "operationId": "programParameter",
        "tags": [
          "Parameters"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ProgramIdPath2"
          },
          {
            "$ref": "#/components/parameters/PageQuery"
          },
          {
            "$ref": "#/components/parameters/PerPageQuery"
          },
          {
            "$ref": "#/components/parameters/OrderQuery"
          },
          {
            "$ref": "#/components/parameters/ProgramStatusQuery"
          },
          {
            "$ref": "#/components/parameters/ProgramNamesQuery"
          },
          {
            "$ref": "#/components/parameters/ProgramParameterCategoryQuery"
          },
          {
            "$ref": "#/components/parameters/ValidUntilQuery"
          },
          {
            "$ref": "#/components/parameters/ValidFromQuery"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProgramParameterPage"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          }
        }
      }
    }
  }
}
````