> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar configurações de provedores

> Utilize este endpoint para recuperar uma lista paginada de configurações de provedores. Você pode filtrar resultados por status ou ID do provedor.



## OpenAPI

````yaml pt/openapi/v3-current/flowker.yaml get /v1/provider-configurations
openapi: 3.1.0
info:
  description: >-
    Referência completa da API para os serviços de orquestração de workflows do
    Flowker, incluindo gerenciamento de catálogo, definições de workflows,
    configurações de executores, configurações de provedores e execuções de
    workflows.
  title: API do Flowker
  version: 1.1.1
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog API
    description: >-
      Explore provedores, executores e gatilhos integrados disponíveis no
      catálogo do Flowker.
  - name: Workflows API
    description: Crie, atualize, ative, desative, clone e exclua definições de workflows.
  - name: Executions API
    description: Inicie execuções de workflows e acompanhe seu status e resultados.
  - name: Executor Configurations API
    description: >-
      Configure, teste e gerencie conexões de executores externos utilizadas
      pelos nós de workflow.
  - name: Provider Configurations API
    description: Configure, teste, habilite e desabilite integrações de provedores.
  - name: Dashboard API
    description: >-
      Recupere resumos agregados de workflows e execuções para dashboards
      operacionais.
  - name: Audit API
    description: >-
      Consulte e verifique eventos de auditoria para conformidade e visibilidade
      operacional.
  - name: Webhooks API
    description: >-
      Receba callbacks de webhooks de sistemas externos para disparar execuções
      de workflows.
paths:
  /v1/provider-configurations:
    get:
      tags:
        - Provider Configurations API
      summary: Listar configurações de provedores
      description: >-
        Utilize este endpoint para recuperar uma lista paginada de configurações
        de provedores. Você pode filtrar resultados por status ou ID do
        provedor.
      operationId: listProviderConfigurations
      parameters:
        - description: Filtrar resultados por status.
          in: query
          name: status
          schema:
            enum:
              - active
              - disabled
            type: string
        - description: Filtrar resultados por um ID de provedor específico.
          in: query
          name: providerId
          schema:
            type: string
        - description: >-
            Número máximo de itens a retornar por página. O padrão é 10. Deve
            estar entre 1 e 100.
          in: query
          name: limit
          schema:
            default: 10
            maximum: 100
            minimum: 1
            type: integer
        - description: >-
            Cursor para paginação. Utilize o valor do campo `nextCursor` de uma
            resposta anterior para recuperar a próxima página.
          in: query
          name: cursor
          schema:
            type: string
        - description: Campo pelo qual ordenar os resultados.
          in: query
          name: sortBy
          schema:
            default: createdAt
            enum:
              - createdAt
              - updatedAt
              - name
            type: string
        - description: >-
            Direção de ordenação. Utilize `ASC` para ascendente ou `DESC` para
            descendente.
          in: query
          name: sortOrder
          schema:
            default: DESC
            enum:
              - ASC
              - DESC
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderConfigurationListOutput'
          description: >-
            Indica que a solicitação foi bem-sucedida e a resposta contém os
            dados solicitados.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica que a solicitação estava malformada ou continha parâmetros
            inválidos.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indica um erro interno inesperado. Se persistir, entre em contato
            com o suporte.
components:
  schemas:
    ProviderConfigurationListOutput:
      example:
        items:
          - id: c3d4e5f6-a7b8-9012-cdef-345678901234
            name: ClearSale Production
            description: ClearSale anti-fraud for Pix transactions
            providerId: clearsale
            config:
              baseUrl: https://api.clearsale.com.br
            status: active
            createdAt: '2026-03-17T14:00:00Z'
            updatedAt: '2026-03-17T14:00:00Z'
        nextCursor: ''
        hasMore: false
      properties:
        hasMore:
          description: Indica se há mais páginas disponíveis.
          example: false
          type: boolean
        items:
          description: Lista de configurações de provedores na página atual.
          items:
            $ref: '#/components/schemas/ProviderConfigurationOutput'
          type: array
        nextCursor:
          description: Cursor para a próxima página.
          example: ''
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Código de erro legível por máquina com o prefixo FLK.
          example: FLK-0001
          type: string
        message:
          description: Explicação do erro legível por humanos.
          example: Invalid input provided
          type: string
        title:
          description: Título curto da categoria de erro.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    ProviderConfigurationOutput:
      example:
        id: c3d4e5f6-a7b8-9012-cdef-345678901234
        name: ClearSale Production
        description: ClearSale anti-fraud for Pix transactions
        providerId: clearsale
        config:
          baseUrl: https://api.clearsale.com.br
          environment: production
        status: active
        metadata:
          team: risk
        createdAt: '2026-03-17T14:00:00Z'
        updatedAt: '2026-03-17T14:00:00Z'
      properties:
        config:
          additionalProperties:
            type: object
          description: Configuração específica do provedor.
          example:
            baseUrl: https://api.clearsale.com.br
            environment: production
          type: object
        createdAt:
          description: Marca temporal de quando a configuração foi criada.
          example: '2026-03-17T14:00:00Z'
          format: date-time
          type: string
        description:
          description: Descrição legível por humanos.
          example: ClearSale anti-fraud for Pix transactions
          type: string
        id:
          description: Identificador único da configuração.
          example: c3d4e5f6-a7b8-9012-cdef-345678901234
          format: uuid
          type: string
        metadata:
          additionalProperties:
            type: object
          description: Metadados personalizados.
          example:
            environment: production
            team: risk
          type: object
        name:
          description: Nome da configuração.
          example: ClearSale Production
          type: string
        providerId:
          description: ID do provedor do catálogo.
          example: clearsale
          type: string
        status:
          description: 'Status atual: `active` ou `disabled`.'
          enum:
            - active
            - disabled
          example: active
          type: string
        updatedAt:
          description: Marca temporal da última atualização.
          example: '2026-03-17T14:00:00Z'
          format: date-time
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Chave de API para autenticar as requisições à API do Flowker.
        Provisionada por meio da variável de ambiente API_KEY durante o
        deployment.

````