List phase fields

GET

/v1/flows/{id}/phases/{phaseId}/fields

Returns the custom fields configured on a phase of the flow — the fields shown to and filled in by users while a card sits in that step of the process.

The returned list includes both currently active fields and previously removed ones: a removed field is not erased from the history, it stays in the response with active:false and index:null. To identify only the fields currently in use in the interface, filter by active:true combined with index not equal to null.

We recommend reading this endpoint before any field update (PUT .../fields), since that update replaces the entire list: the id values of existing fields must be reused in the update payload so they are not accidentally removed.

Requisição

Parâmetros de Caminho

Respostas

🟢200Phase fields

application/json

Object containing the 'fields' array with the fields configured on the phase, including both active and removed (soft-deleted) fields.

Bodyapplication/json

Response Example

{
    "fields": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "help": "string",
            "description": "string",
            "required": true,
            "editable": true,
            "active": true,
            "category": "default",
            "index": 0,
            "sectionMetadata": {
                "sectionId": "string",
                "sectionTitle": "string",
                "sectionIndex": 0
            },
            "options": [
                "string"
            ]
        }
    ]
}

Modificado em 2026-07-28 20:38:32