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

# Get All Customers

> Retrieve all customer from the database.

[The Customers Data Model](https://docs.rootfi.dev/api-reference/customers/overview) is designed to streamline the management and retrieval of account-related information across various payments platforms.


## OpenAPI

````yaml GET /payments/customers
openapi: 3.0.1
info:
  title: rootfi
  version: v3
servers:
  - url: https://api.rootfi.dev/v3
    description: global
  - url: https://api.sa.rootfi.dev/v3
    description: saudi
security: []
paths:
  /payments/customers:
    get:
      tags:
        - PaymentsCustomers
      summary: Get All Customers
      description: Retrieve all customer from the database.
      operationId: payments_customers_list
      parameters:
        - name: limit
          in: query
          description: The number of customers you want to retrieve
          required: false
          schema:
            type: integer
            nullable: true
          examples:
            Example1:
              value: 1
        - name: next
          in: query
          description: The next page of objects to retrieve
          required: false
          schema:
            type: string
            nullable: true
          examples:
            Example1:
              value: nhgdfghjgyffcvjhgc==
        - name: prev
          in: query
          description: The previous page of objects to retrieve
          required: false
          schema:
            type: string
            nullable: true
        - name: select
          in: query
          description: >-
            Comma separated fields to select. Supported values are raw_data,
            data_hash
          required: false
          schema:
            type: string
            nullable: true
          examples:
            Example1:
              value: raw_data
        - name: rootfi_updated_at[gte]
          in: query
          description: Filter by rootfi_updated_at Greater than or Equal To.
          required: false
          schema:
            type: string
            nullable: true
        - name: rootfi_company_id[eq]
          in: query
          description: >-
            Filter by rootfi_company_id. You can filter by any field using this
            syntax field_name[operator]
          required: false
          schema:
            type: integer
            nullable: true
        - name: include_deleted_records
          in: query
          description: >-
            Include deleted records. By default, deleted records are not
            included. Supported values are true and false
          required: false
          schema:
            type: string
            nullable: true
          examples:
            Example1:
              value: 'false'
        - name: return_count
          in: query
          description: Return the count of the objects. Supported values are true and false
          required: false
          schema:
            type: string
            nullable: true
          examples:
            Example1:
              value: 'false'
        - name: sort[rootfi_created_at]
          in: query
          description: Sort by rootfi_created_at
          required: false
          schema:
            $ref: '#/components/schemas/SortOrder'
            nullable: true
        - name: sort[rootfi_updated_at]
          in: query
          description: Sort by rootfi_updated_at
          required: false
          schema:
            $ref: '#/components/schemas/SortOrder'
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paymentsGetCustomerResponse'
              examples:
                Example1:
                  value:
                    data:
                      - rootfi_id: 157
                        rootfi_deleted_at: null
                        rootfi_created_at: '2024-01-22T05:07:31.465Z'
                        rootfi_updated_at: '2024-01-22T05:07:31.000Z'
                        rootfi_company_id: 1089
                        platform_id: '123456'
                        created_at: '2024-01-22T05:07:31.465Z'
                        updated_at: '2024-01-22T05:07:31.465Z'
                        name: John Doe
                        tax_number: '1234567890'
                        currency_id: '1234567890'
                        external_links:
                          - rootfi_id: 278264
                            platform_id: >-
                              CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_WEBSITE
                            link: https://www.google.com
                            type: WEBSITE
                        phone_numbers:
                          - rootfi_id: 278264
                            platform_id: >-
                              CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_PHONE
                            number: '1234567890'
                            type: MOBILE
                        addresses:
                          - rootfi_id: 278264
                            platform_id: '123456_1'
                            platform_unique_id: '123456'
                            type: BILLING
                            data_model_id: '123456'
                            street: 123 Main Street
                            locality: Main Street
                            city: New York
                            state: New York
                            pincode: '123456'
                            country: USA
                    prev: eyJyb290ZmlfaWQiOjQ0MDA2MX0=
                    next: eyJyb291ZmlfaWQiOjQ0MDA2MX0=
                    total_count: 123
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RootFiAPIResponseType'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RootFiAPIResponseType'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RootFiAPIResponseType'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RootFiAPIResponseType'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SortOrder:
      title: SortOrder
      type: string
      enum:
        - ASC
        - DESC
    paymentsGetCustomerResponse:
      title: paymentsGetCustomerResponse
      type: object
      description: The data of the customers endpoint.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/paymentsCustomerObject'
      required:
        - data
      allOf:
        - $ref: '#/components/schemas/CommonReadResponse'
    RootFiAPIResponseType:
      title: RootFiAPIResponseType
      type: object
      properties:
        error:
          $ref: '#/components/schemas/RootFiAPIResponseErrorType'
          description: The error message
      required:
        - error
    paymentsCustomerObject:
      title: paymentsCustomerObject
      type: object
      properties: {}
      allOf:
        - $ref: '#/components/schemas/AccountingRootFiBaseFields'
        - $ref: '#/components/schemas/paymentsCustomerFields'
    CommonReadResponse:
      title: CommonReadResponse
      type: object
      properties:
        prev:
          type: string
          nullable: true
          description: The previous page of objects to retrieve
        next:
          type: string
          nullable: true
          description: The next page of objects to retrieve
        total_count:
          type: integer
          nullable: true
          description: The total count of the objects
    RootFiAPIResponseErrorType:
      title: RootFiAPIResponseErrorType
      type: object
      properties:
        message:
          type: string
          description: The error message
        code:
          type: string
          description: The error code
        field:
          type: string
          description: The status of the error
      required:
        - message
        - code
        - field
    AccountingRootFiBaseFields:
      title: AccountingRootFiBaseFields
      type: object
      properties:
        rootfi_id:
          type: number
          format: double
          description: The unique ID we assign for that data's information
          example: 157
        rootfi_deleted_at:
          type: string
          format: date-time
          nullable: true
          description: The date at which the data was deleted in the accounting platform
        rootfi_created_at:
          type: string
          format: date-time
          description: The date at which RootFi first synced this data
          example: '2024-01-22T05:07:31.465Z'
        rootfi_updated_at:
          type: string
          format: date-time
          description: The latest date at which RootFi updated this data
          example: '2024-01-22T05:07:31.000Z'
        rootfi_company_id:
          type: number
          format: double
          description: The ID of the company in the accounting platform
          example: 1089
        platform_id:
          type: string
          description: An unique custom RootFi ID made from platform's unique_id.
          example: '123456'
        platform_unique_id:
          type: string
          nullable: true
          description: The ID of the data in the accounting platform.
        raw_data:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            A JSON containing fields that you can directly get from the
            accounting platform.
        data_hash:
          type: string
          nullable: true
          description: The hash of the data
      required:
        - rootfi_id
        - rootfi_created_at
        - rootfi_updated_at
        - rootfi_company_id
        - platform_id
    paymentsCustomerFields:
      title: paymentsCustomerFields
      type: object
      properties:
        created_at:
          type: string
          nullable: true
          description: >-
            The ISO 8601 timestamp indicating when this customer record was
            created on the payment platform.
        name:
          type: string
          nullable: true
          description: >-
            The full name or business name of the customer as it appears on the
            payment platform.
        tax_number:
          type: string
          nullable: true
          description: >-
            The tax identification number for the customer (e.g., GST, EIN, VAT
            number). This is used for tax reporting and compliance purposes.
        currency_id:
          type: string
          nullable: true
          description: >-
            The currency code (e.g., USD, EUR, GBP) that is the default currency
            for this customer's transactions.
        updated_at:
          type: string
          nullable: true
          description: >-
            The ISO 8601 timestamp indicating when this customer record was last
            modified on the payment platform.
        external_links:
          type: array
          items:
            $ref: '#/components/schemas/paymentsExternalLinks'
          nullable: true
          description: >-
            An array of external links associated with this customer, such as
            website URLs or email addresses.
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/paymentsPhoneNumbers'
          nullable: true
          description: >-
            An array of phone numbers associated with this customer, including
            mobile, telephone, and fax numbers.
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/paymentsAddresses'
          nullable: true
          description: >-
            An array of physical addresses associated with this customer, such
            as billing, shipping, or company addresses.
    paymentsExternalLinks:
      title: paymentsExternalLinks
      type: object
      properties:
        rootfi_id:
          type: integer
          nullable: true
          description: The unique RootFi identifier assigned to this external link record.
        platform_id:
          type: string
          nullable: true
          description: >-
            The unique identifier for this external link on the payment
            platform.
        link:
          type: string
          nullable: true
          description: >-
            The URL or email address associated with this external link (e.g.,
            website URL or email address).
        type:
          $ref: '#/components/schemas/ExternalLinkType'
          nullable: true
          description: >-
            The category of external link, indicating whether it is a website
            URL or an email address.
    paymentsPhoneNumbers:
      title: paymentsPhoneNumbers
      type: object
      properties:
        rootfi_id:
          type: integer
          nullable: true
          description: The unique RootFi identifier assigned to this phone number record.
        platform_id:
          type: string
          nullable: true
          description: The unique identifier for this phone number on the payment platform.
        number:
          type: string
          nullable: true
          description: >-
            The complete phone number in international format, including country
            code and area code.
        type:
          $ref: '#/components/schemas/ContactNumberType'
          nullable: true
          description: >-
            The category of phone number, indicating whether it is a mobile,
            telephone, or fax number.
    paymentsAddresses:
      title: paymentsAddresses
      type: object
      properties:
        rootfi_id:
          type: integer
          nullable: true
          description: The unique RootFi identifier assigned to this address record.
        platform_id:
          type: string
          nullable: true
          description: >-
            The unique identifier for this address on the payment platform,
            typically generated from the platform's unique identifier.
        platform_unique_id:
          type: string
          nullable: true
          description: >-
            An additional unique identifier provided by the payment platform for
            this address.
        type:
          $ref: '#/components/schemas/AddressType'
          nullable: true
          description: >-
            The category of address, indicating its purpose (e.g., SHIPPING for
            delivery addresses, BILLING for payment addresses, COMPANY for
            business addresses).
        data_model_id:
          type: string
          nullable: true
          description: >-
            The identifier of the parent data model (e.g., customer, invoice)
            that this address is associated with.
        street:
          type: string
          nullable: true
          description: The street address line, including building number and street name.
        locality:
          type: string
          nullable: true
          description: The neighborhood, district, or locality within the city or town.
        city:
          type: string
          nullable: true
          description: The city or town name where this address is located.
        state:
          type: string
          nullable: true
          description: The state, province, or region where this address is located.
        pincode:
          type: string
          nullable: true
          description: >-
            The postal code or ZIP code for this address, used for mail delivery
            and location identification.
        country:
          type: string
          nullable: true
          description: >-
            The country name or country code (ISO 3166-1 alpha-2) where this
            address is located.
    ExternalLinkType:
      title: ExternalLinkType
      type: string
      enum:
        - EMAIL
        - WEBSITE
    ContactNumberType:
      title: ContactNumberType
      type: string
      enum:
        - MOBILE
        - TELEPHONE
        - FAX
    AddressType:
      title: AddressType
      type: string
      enum:
        - SHIPPING
        - BILLING
        - COMPANY
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````