Skip to content
Developer Docs

Configuration List

GET
/flow-customization/v1/configurations

Lists the branding and behaviour configurations available to customize the collection experience. Used to adapt the flow UI to the business.

Paginated list scoped to the business identified by x-tenant-id. Each entry includes the configuration uuid, name and description — use the detail endpoint to retrieve the full visual, operation and redirection settings. By default the list includes all configurations regardless of status.

Autorizaciones

OAuth2

OAuth2 security scheme

clientCredentials Flow
Token URL"/api/v2/auth/token"
Scopes:
  • "zertiban-api"Access to the API

Parámetros

Header Parameters

x-tenant-id*

Tenant identifier (UUID of the business)

Tipo
string
Requerido
Formato
"uuid"

Query Parameters

limit

Maximum number of results to return

Tipo
integer
Mínimo
1
Máximo
50
Por defecto
10
offset

Number of results to skip

Tipo
integer
Mínimo
0
Por defecto
0
q_isDefault

Filter configurations by whether they are the default one

Tipo
boolean
q_status

Filter configurations by status

Tipo
string
Valores válidos
"ACTIVE""DISABLED"

Respuestas

Successful response with list of configurations

application/json
JSON
{
  
"total": 78,
  
"results": [
  
  
{
  
  
  
"uuid": "f826a13c-5342-4281-a2d4-c4282441391d",
  
  
  
"name": "First config",
  
  
  
"description": "My first configuration",
  
  
  
"isDefault": true,
  
  
  
"status": "ACTIVE"
  
  
}
  
]
}

Playground

Autorización
Headers
Variables
Key
Value

Ejemplos