> ## Documentation Index > Fetch the complete documentation index at: https://docs.bevits.com/llms.txt > Use this file to discover all available pages before exploring further. # Consultar catálogo do construtor de flows > Lista os gatilhos no formato plataforma.evento, indicando se cada um está disponível para a loja, os tipos de bloco aceitos na criação de flows e um exemplo completo. Com trigger, devolve também os campos de condição desse gatilho, com operadores e valores permitidos. ## OpenAPI ````yaml /openapi.json get /v1/flow-builder/catalog openapi: 3.1.0 info: title: Bevits API version: 1.0.0 description: >- API pública para consultar dados de CRM, compras e automação de uma organização Bevits e criar automações como rascunho para revisão e ativação. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.bevits.com description: Produção security: - bearerAuth: [] tags: - name: Sistema description: Disponibilidade da API. - name: Identidade description: Identidade da organização e da API key. - name: Clientes description: Clientes e suas relações. - name: Segmentos description: Segmentos de clientes. - name: Compras description: Compras importadas das integrações. - name: Dados do CRM description: Tags e definições de atributos. - name: Automações description: Flows de automação. - name: Campanhas description: Campanhas de e-mail. paths: /v1/flow-builder/catalog: get: tags: - Automações summary: Consultar catálogo do construtor de flows description: >- Lista os gatilhos no formato plataforma.evento, indicando se cada um está disponível para a loja, os tipos de bloco aceitos na criação de flows e um exemplo completo. Com trigger, devolve também os campos de condição desse gatilho, com operadores e valores permitidos. operationId: getFlowBuilderCatalog parameters: - $ref: '#/components/parameters/FlowBuilderTrigger' responses: '200': $ref: '#/components/responses/FlowBuilderCatalog' '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/ValidationError' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: parameters: FlowBuilderTrigger: name: trigger in: query description: >- Gatilho no formato plataforma.evento, como nuvemshop.order_created. Quando informado, a resposta inclui os campos de condição desse gatilho. schema: type: string pattern: ^[a-z]+\.[a-z_]+$ responses: FlowBuilderCatalog: description: Catálogo do construtor de flows. content: application/json: schema: $ref: '#/components/schemas/FlowBuilderCatalog' Unauthorized: description: API key ausente, inválida, expirada ou revogada. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: authentication_error message: Invalid API key. request_id: req_07f6cdc3c20249d6afcd90b4 ValidationError: description: Um parâmetro não passou pela validação. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: validation_error message: Invalid query parameters. param: limit request_id: req_07f6cdc3c20249d6afcd90b4 RateLimited: description: Limite de requisições excedido. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' InternalError: description: Erro inesperado no servidor. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: FlowBuilderCatalog: type: object required: - object - triggers - node_types - example properties: object: type: string const: flow_builder_catalog triggers: type: array items: type: object required: - trigger - description - available properties: trigger: type: string description: >- Gatilho no formato plataforma.evento, como nuvemshop.order_created. description: type: string available: type: boolean description: Indica se a loja pode usar este gatilho. unavailable_reason: type: string description: Motivo pelo qual o gatilho não está disponível. conditions: type: object description: Campos de condição do gatilho informado em trigger. required: - trigger - fields properties: trigger: type: string fields: type: array items: $ref: '#/components/schemas/FlowConditionField' node_types: type: array description: Tipos de bloco aceitos na criação de flows. items: type: object required: - type - description - fields properties: type: type: string description: type: string fields: type: string example: type: object description: Descrição completa e válida de um flow, para usar como modelo. ErrorResponse: type: object required: - error properties: error: $ref: '#/components/schemas/Error' RateLimitErrorResponse: allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object required: - retry_after properties: retry_after: type: integer minimum: 1 description: Segundos até uma nova tentativa. FlowConditionField: type: object required: - field - label - type - operators properties: field: type: string description: Campo no formato grupo.atributo, como order.paymentMethod. label: type: string type: type: string operators: type: array items: $ref: '#/components/schemas/FlowConditionOperator' values: type: array description: Valores permitidos, quando o campo tem uma lista fechada. items: type: object required: - value - label properties: value: type: string label: type: string note: type: string Error: type: object required: - type - message - request_id properties: type: type: string enum: - authentication_error - conflict - internal_error - invalid_request - not_found - permission_denied - rate_limited - validation_error message: type: string param: type: string request_id: type: string pattern: ^req_[a-f0-9]{24}$ FlowConditionOperator: type: string enum: - equals - not_equals - greater_than - less_than - greater_than_or_equal - less_than_or_equal - contains - not_contains - starts_with - ends_with - is_empty - is_not_empty - includes - not_includes headers: RetryAfter: description: Segundos até uma nova tentativa. schema: type: integer minimum: 1 RateLimitLimit: description: Limite total da janela atual. schema: type: integer example: 600 RateLimitRemaining: description: Requisições restantes na janela atual. schema: type: integer example: 599 RateLimitReset: description: Instante UTC em que a janela atual termina. schema: type: string format: date-time securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: bvt_live_... description: API key criada nas configurações da organização. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.