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

# List the providers you can connect

> The catalogue of providers Flow Payroll can send to. Each entry says how the provider is signed in to (`authMethod`), which sign-in details it needs (`requiredCredentialFields`), what it can do (`capabilities`), and which kinds of data it can be read for (`importTypes`). Use the `slug` when creating a connection.



## OpenAPI

````yaml /api-reference/specs/integrations.json get /providers
openapi: 3.0.1
info:
  title: Integrations Service
  description: Integrations API for FlowPayroll
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/integrations
security:
  - X-Auth-Token: []
tags:
  - name: Providers
    description: >-
      The providers Flow Payroll can send to, what each can do, and the sign-in
      details it needs.
  - name: Connections
    description: >-
      Your organisation's provider accounts: create one, save its sign-in
      details, test it, pause it, disconnect it or remove it.
  - name: Scheme links
    description: >-
      Which pension scheme sends through which connection. Linking is the
      opt-in: nothing is sent for a scheme until it is linked.
  - name: Activity
    description: >-
      Every submission to a provider and every read from it, with status,
      attempts and the provider reference. Retry what failed, cancel what has
      not gone yet.
  - name: Provider data
    description: >-
      How fresh the data read from the provider is, and how to refresh it on
      demand.
  - name: Initial import
    description: >-
      Read everything the provider already holds for the employer, so Flow
      Payroll starts in step with it.
paths:
  /providers:
    get:
      tags:
        - Providers
      summary: List the providers you can connect
      description: >-
        The catalogue of providers Flow Payroll can send to. Each entry says how
        the provider is signed in to (`authMethod`), which sign-in details it
        needs (`requiredCredentialFields`), what it can do (`capabilities`), and
        which kinds of data it can be read for (`importTypes`). Use the `slug`
        when creating a connection.
      operationId: ListProviders
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderResponseListResponseBody'
components:
  schemas:
    ProviderResponseListResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ProviderResponseListContentResponse'
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ProviderResponseListContentResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProviderResponse'
          nullable: true
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          nullable: true
      additionalProperties: false
    ProviderResponse:
      type: object
      properties:
        slug:
          type: string
        displayName:
          type: string
        description:
          type: string
        category:
          enum:
            - None
            - Accounting
            - Pension
            - Payments
            - Messaging
          type: string
        authMethod:
          enum:
            - None
            - OAuthAuthorisationCode
            - BasicCredentials
          type: string
        catalogueStatus:
          enum:
            - None
            - Available
            - Beta
            - ComingSoon
          type: string
        capabilities:
          type: array
          items:
            type: string
        requiredCredentialFields:
          type: array
          items:
            type: string
        importTypes:
          type: array
          items:
            type: string
        rateLimitPerMinute:
          type: integer
          format: int32
        rateLimitPerDay:
          type: integer
          format: int32
        supportsDraftJournals:
          type: boolean
        maxAttachmentsPerDocument:
          type: integer
          format: int32
        maxContactPersons:
          type: integer
          format: int32
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.