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

# Alle klanten oplijsten

> Returns every customer visible to the user, as a plain array, without pagination.

For large portfolios, prefer `POST /customers`, which is paginated and filterable.

Only customers the user can access are included: usually all the accounting firm's customers, or only some of them if the firm restricted the user in MyCodaclean.

**Required scope:** `customers:read`




## OpenAPI

````yaml GET /customers
openapi: 3.1.0
info:
  title: Codaclean API
  version: '1.0'
  description: >
    The Codaclean external API lets partner software (accounting tools, practice
    management software, sync agents) integrate with Codaclean on behalf of an
    accounting firm: manage its customers, request CODA and CODB mandates, and
    retrieve the CODA and CODB files Codaclean receives for them.
servers:
  - url: https://api.codaclean.io/v1
    description: Production
  - url: https://api.test.codaclean.io/v1
    description: Staging
security:
  - apiKeyAuth: []
    bearerAuth: []
tags:
  - name: Authentication
    description: Obtain and refresh the ID token sent with every other call.
  - name: Utilities
    description: Connectivity check.
  - name: Customers
    description: The customers (client companies) managed by the accounting firm.
  - name: Bank accounts
    description: Bank accounts (IBANs) linked to a customer.
  - name: Customer payroll providers
    description: Payroll providers (social secretariats) linked to a customer.
  - name: Mandates
    description: CODA mandates (per bank account) and CODB mandates (per payroll provider).
  - name: Reference data
    description: Banks and payroll providers known to Codaclean.
  - name: CODA files
    description: Bank statement files in CODA format.
  - name: CODB files
    description: Payroll files in CODB format, delivered by payroll providers.
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List all customers
      description: >
        Returns every customer visible to the user, as a plain array, without
        pagination.


        For large portfolios, prefer `POST /customers`, which is paginated and
        filterable.


        Only customers the user can access are included: usually all the
        accounting firm's customers, or only some of them if the firm restricted
        the user in MyCodaclean.


        **Required scope:** `customers:read`
      operationId: listAllCustomers
      responses:
        '200':
          description: Customers visible to the user.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LegacyCustomer'
              examples:
                customers:
                  summary: All customers
                  value:
                    - enterpriseNumber: 0764.042.472
                      name: Boulangerie Dupont SRL
                      address:
                        street: Rue du Marché 12
                        street2: ''
                        zipCode: '1000'
                        municipality: Bruxelles
                        country: Belgique
                      accountingRef: DUPONT
                      bankAccounts:
                        - iban: BE49001163522171
                          currency: EUR
                          bic: GEBA BE BB
                        - iban: BE68001466139034
                          currency: EUR
                          bic: GEBA BE BB
                        - iban: BE40751680738663
                          currency: EUR
                          bic: AXAB BE 22
                        - iban: BE10732141110904
                          currency: EUR
                          bic: CREG BE BB
                        - iban: BE79104034016533
                          currency: EUR
                          bic: NICA BE BB
                        - iban: BE21103265210903
                          currency: EUR
                          bic: NICA BE BB
                      contact:
                        name: Marie Dupont
                        function: CEO
                        email: marie.dupont@example.com
                        language: nl
                      isConfidential: false
                      payrollProviders:
                        - code: sdworx
                          sourceCode: sdworx
                        - code: twinntax
                          sourceCode: Twinntax
                      id: 675b4183d350b74dad2f46ec
                    - enterpriseNumber: 0755.556.457
                      name: Garage Peeters BV
                      address:
                        street: Kerkstraat 25
                        street2: ''
                        zipCode: '1050'
                        municipality: Bruxelles
                        country: Belgique
                      accountingRef: PEETERS
                      bankAccounts:
                        - iban: BE59732578835326
                          currency: EUR
                          bic: CREG BE BB
                        - iban: BE87088425005794
                          currency: EUR
                          bic: GKCC BE BB
                        - iban: BE42088136494654
                          currency: EUR
                          bic: GKCC BE BB
                      contact:
                        name: Jan Peeters
                        function: CEO
                        email: jan.peeters@example.com
                        language: en
                      payrollProviders:
                        - code: partena_professional
                          sourceCode: partena_professional
                        - code: twinntax
                          sourceCode: Twinntax
                        - code: '***other***'
                          sourceCode: '*'
                      id: 675b41d6d350b74dad2f46ed
                      isConfidential: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    LegacyCustomer:
      type: object
      properties:
        id:
          type: string
        enterpriseNumber:
          type: string
          description: Belgian enterprise number, formatted `0123.456.789`.
        name:
          type: string
        accountingRef:
          type: string
        address:
          $ref: '#/components/schemas/Address'
        contact:
          $ref: '#/components/schemas/Contact'
        isConfidential:
          type: boolean
        bankAccounts:
          type: array
          items:
            type: object
            properties:
              iban:
                type: string
              currency:
                type: string
                description: Defaults to `EUR`.
              bic:
                type: string
        payrollProviders:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              sourceCode:
                type: string
    Address:
      type: object
      additionalProperties: false
      properties:
        street:
          type: string
        street2:
          type: string
        zipCode:
          type: string
        municipality:
          type: string
        country:
          type: string
    Contact:
      type: object
      additionalProperties: false
      description: >-
        Contact person at the customer. Mandate signature requests are sent to
        this contact.
      properties:
        name:
          type: string
          description: Name of the person who signs the mandates.
        function:
          type: string
        email:
          type: string
          description: Email address the mandate signature requests are sent to.
        language:
          type: string
          description: >-
            Language of the contact: `fr`, `nl` or `en`. Used for the mandate
            documents and emails.
    Message:
      type: object
      description: Confirmation returned by actions that do not return a resource.
      required:
        - message
      properties:
        message:
          type: string
    Error:
      type: object
      description: >
        Error body. `code` is a stable, machine-readable token; it is present on
        errors returned by the customers, mandates and reference-data endpoints.
        Some errors carry extra keys, such as `fields` or `candidates`.
      required:
        - message
      properties:
        message:
          type: string
          description: Human-readable description. Do not parse it.
        code:
          type: string
          description: |
            Machine-readable error code.

            **See also:** [Errors](/api/errors#error-codes)
        fields:
          type: array
          items:
            type: string
          description: >-
            Offending fields. Present with `unknownField` and
            `fieldNotUpdatable`.
        candidates:
          type: array
          description: Present with `connectorSelectionRequired`.
          items:
            $ref: '#/components/schemas/ConnectorCandidate'
    ConnectorCandidate:
      type: object
      properties:
        connectorId:
          type: integer
        name:
          type: string
        bicCode:
          type: string
        available:
          type: boolean
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired ID token, or user not allowed to use the
        API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            noToken:
              summary: No ID token
              value:
                message: Unauthorized
            invalidToken:
              summary: Invalid or expired ID token
              value:
                message: Unauthorized
    Forbidden:
      description: >-
        Missing or invalid API key, missing scope (`forbiddenScope`), or access
        denied.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            noApiKey:
              summary: No API key
              value:
                message: Forbidden
            invalidApiKey:
              summary: Invalid API key
              value:
                message: Forbidden
    TooManyRequests:
      description: Rate limit or quota exceeded for this API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          examples:
            tooManyRequests:
              summary: Rate limit exceeded
              value:
                message: Too Many Requests
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                message: Internal server error
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Identifies the partner software. Issued by Codaclean. Required on every
        call, including `POST /token`.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT (Cognito ID token)
      description: >-
        Identifies the user and their accounting firm. Send the `idToken`
        returned by `POST /token` as `Authorization: Bearer <idToken>`. Valid
        for 1 hour.

````