---
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 with localization
Get a paginated list of programs with localization parameters.
Returns a `translation` object with language-specific parameter information.
For information about programs, refer to [Core objects](doc:setup-overview#program).
# 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": {
"LanguageQuery": {
"name": "language",
"in": "query",
"description": "Allows localization object content to be localized as specified.\n* `en-US` - US English\n* `pt-BR` - Brazilian Portuguese\n",
"schema": {
"type": "string",
"enum": [
"en-US",
"pt-BR"
]
},
"example": "en-US"
},
"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
},
"ProgramParameterCategoryQuery": {
"name": "category",
"in": "query",
"description": "One or more program parameter categories. 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",
"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"
},
"RequiredQuery": {
"name": "required",
"in": "query",
"description": "Can be `REQUIRED` and/or `OPTIONAL`. Use `,` as separator.",
"schema": {
"type": "string"
},
"example": "REQUIRED"
},
"SearchQuery": {
"name": "search",
"in": "query",
"description": "Filter for provided text in the localization object's `name` field.",
"schema": {
"type": "string"
},
"example": "test"
},
"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"
}
}
},
"LegacyBoolean": {
"type": "boolean",
"description": "Is parameter from a legacy process and kept for compatibility only?",
"example": false
},
"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
},
"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."
},
"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"
},
"ProgramParameterStatus": {
"type": "string",
"description": "Program parameter status:\n * `ACTIVE` - Parameter is operational \n * `INACTIVE` Parameter cannot be used\n",
"enum": [
"ACTIVE",
"INACTIVE"
],
"example": "ACTIVE"
},
"ProgramParameterTranslated": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/ProgramRelationshipID"
},
"parameter_id": {
"$ref": "#/components/schemas/ParameterID"
},
"name": {
"$ref": "#/components/schemas/ProgramParameterName"
},
"category": {
"$ref": "#/components/schemas/ProgramParameterCategory"
},
"type": {
"$ref": "#/components/schemas/ProgramParameterValueType"
},
"value": {
"$ref": "#/components/schemas/FloatParameterValue"
},
"valid_from": {
"$ref": "#/components/schemas/ValidFrom"
},
"valid_until": {
"$ref": "#/components/schemas/ValidUntil"
},
"account_parameter": {
"$ref": "#/components/schemas/AccountParameterBoolean"
},
"status": {
"$ref": "#/components/schemas/ProgramParameterStatus"
},
"required": {
"$ref": "#/components/schemas/RequiredOrOptional"
},
"update_date": {
"$ref": "#/components/schemas/UpdateDate"
},
"legacy": {
"$ref": "#/components/schemas/LegacyBoolean"
},
"translation": {
"$ref": "#/components/schemas/ProgramParameterTranslation"
}
}
},
"ProgramParameterTranslatedPage": {
"type": "object",
"properties": {
"current_page": {
"$ref": "#/components/schemas/CurrentPage"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgramParameterTranslated"
}
},
"pages": {
"$ref": "#/components/schemas/Pages"
},
"per_page": {
"$ref": "#/components/schemas/PerPage"
},
"total_items": {
"$ref": "#/components/schemas/TotalItems"
}
}
},
"ProgramParameterTranslation": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/TranslatedProgramParameterName"
},
"description": {
"$ref": "#/components/schemas/ProgramParameterDescription"
},
"details": {
"$ref": "#/components/schemas/TranslatedProgramParameterDetails"
},
"language": {
"$ref": "#/components/schemas/TranslatedProgramParameterLanguage"
}
}
},
"ProgramParameterValueType": {
"type": "string",
"description": "Parameter value type",
"enum": [
"INTEGER",
"DECIMAL",
"PERCENTAGE"
],
"example": "DECIMAL"
},
"ProgramRelationshipID": {
"type": "integer",
"format": "int64",
"description": "Program relationship ID with parameter",
"example": 1
},
"RequiredOrOptional": {
"type": "string",
"description": "Sets whether the parameter is required or optional.",
"enum": [
"REQUIRED",
"OPTIONAL"
],
"example": "REQUIRED"
},
"TotalItems": {
"type": "integer",
"format": "int32",
"description": "Total number of items",
"example": 3
},
"TranslatedProgramParameterDetails": {
"type": "string",
"description": "Localized program parameter details.",
"example": "Defines whether the projected interest..."
},
"TranslatedProgramParameterLanguage": {
"type": "string",
"description": "Localized program parameter language",
"example": "en-us"
},
"TranslatedProgramParameterName": {
"type": "string",
"description": "Localized program parameter name",
"example": "Interest projection reversal"
},
"UpdateDate": {
"type": "string",
"format": "date-time",
"description": "Parameter last updated datetime. Format = yyyy-mm-ddThh:mm:ss.",
"example": "2020-12-31 23:59:59"
},
"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/v2/programs/{program_id}/parameters": {
"get": {
"summary": "List program parameters with localization",
"description": "Get a paginated list of programs with localization parameters. \n\nReturns a `translation` object with language-specific parameter information. \n\nFor information about programs, refer to [Core objects](https://developers.pismo.io/pismo-docs/docs/setup-overview#program).\n",
"operationId": "programParameterV2",
"tags": [
"Parameters"
],
"parameters": [
{
"$ref": "#/components/parameters/ProgramIdPath2"
},
{
"$ref": "#/components/parameters/PageQuery"
},
{
"$ref": "#/components/parameters/PerPageQuery"
},
{
"$ref": "#/components/parameters/OrderQuery"
},
{
"$ref": "#/components/parameters/OrderByQuery"
},
{
"$ref": "#/components/parameters/ProgramParameterCategoryQuery"
},
{
"$ref": "#/components/parameters/ProgramStatusQuery"
},
{
"$ref": "#/components/parameters/RequiredQuery"
},
{
"$ref": "#/components/parameters/ProgramNamesQuery"
},
{
"$ref": "#/components/parameters/ValidFromQuery"
},
{
"$ref": "#/components/parameters/ValidUntilQuery"
},
{
"$ref": "#/components/parameters/SearchQuery"
},
{
"$ref": "#/components/parameters/LanguageQuery"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgramParameterTranslatedPage"
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequest"
}
}
}
}
}
}
```