Get bureau query configuration

GET

/v1/flows/{flowId}/phases/{phaseId}/query-config

Returns the bureau query configuration defined for a phase — including the configuration title and the list of bureau/AgRisk product identifiers that will be queried when a card enters that phase.

If the phase does not yet have any query configuration defined, the API returns an error indicating the resource was not found.

We recommend reading this configuration before deciding whether to create (POST) or update (PUT) an existing configuration.

This configuration is independent from the agrisk phase action, which is responsible for actually triggering the queries on the phase — see the phase actions domain for more details on that complementary step.

Requisição

Parâmetros de Caminho

Respostas

🟢200Configuration found

application/json

The phase's bureau query configuration was returned successfully.

Bodyapplication/json

🟠404Configuration not found

Response Example

200 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "products": [
        "string"
    ]
}

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

Página anterior

Bureau Query — Overview

Próxima página

Create bureau query configuration