# Get All Customers

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/customers:
    get:
      summary: Get All Customers
      deprecated: false
      description: Get all Customers
      operationId: getAllCustomers
      tags:
        - Endpoints/Customers
        - customer
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
              example:
                complytId: 9f8ee193-1a71-42b4-801d-ee1d8a161fbe
                externalId: externalIdExample
                source: sourceExample
                name: Complyt
                address:
                  city: Sacramento
                  country: US
                  county: null
                  state: CA
                  street: 944 W. Wintergreen St.
                  zip: '95823'
                  isPartial: false
                email: example@some.mail.com
                customerType: RETAIL
                internalTimestamps:
                  createdDate: '2023-01-10T17:40:44.357'
                  updatedDate: '2023-01-11T17:10:21.275'
                externalTimestamps:
                  createdDate: '2022-10-19T07:00:00'
                  updatedDate: '2022-10-19T09:07:54.585'
                comment: this is a customer
          headers: {}
          x-apidog-name: Successful operation
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Something is wrong with your request
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Unauthorized
        '403':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Forbidden
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Internal Error
      security:
        - bearer: []
      x-apidog-folder: Endpoints/Customers
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/563651/apis/api-7838832-run
components:
  schemas:
    Customer:
      required:
        - externalId
        - source
        - externalTimestamps
      type: object
      properties:
        complytId:
          type: string
          description: The unique identifier in Complyt of the customer
          format: uuid
        externalId:
          maxLength: 256
          minLength: 1
          type: string
          description: >-
            the attribute designed to receive a unique identifier provided by
            API consumers themselves (e.g. pass your own ID)
        source:
          pattern: ^(10|[1-9])$
          type: string
          description: >-
            a single digit which identifies your different stores, checkout
            solutions, marketplaces, etc. defined by the API consumers (to avoid
            external id duplications)
        name:
          maxLength: 256
          minLength: 1
          type: string
          description: The customer's name
        address:
          type: object
          x-apidog-refs:
            01JGH7DHX4HAF9P7RKAMV2S15X:
              $ref: '#/components/schemas/addressOfCustomer'
              x-apidog-overrides:
                isPartial: null
          x-apidog-orders:
            - 01JGH7DHX4HAF9P7RKAMV2S15X
          properties:
            city: &ref_1
              maxLength: 100
              minLength: 0
              type: string
            country: &ref_2
              maxLength: 50
              minLength: 0
              type: string
            county: &ref_3
              maxLength: 100
              minLength: 0
              type: string
            state: &ref_4
              maxLength: 100
              minLength: 0
              type: string
            street: &ref_5
              maxLength: 200
              minLength: 0
              type: string
            region: &ref_6
              maxLength: 20
              minLength: 0
              type: string
            zip: &ref_7
              maxLength: 20
              minLength: 0
              type: string
          x-apidog-ignore-properties:
            - city
            - country
            - county
            - state
            - street
            - region
            - zip
        email:
          type: string
          description: An (Optional) Email address associated with the customer
        customerType:
          type: string
          description: >-
            Indicates whether the customer is 'retail'/'reseller'/'marketplace'.
            Defaults to 'retail' if no customer type is provided
          enum:
            - RETAIL
            - MARKETPLACE
            - RESELLER
            - RETAIL_EXEMPT
        internalTimestamps:
          $ref: '#/components/schemas/internalTimestamps'
        externalTimestamps:
          $ref: '#/components/schemas/externalTimestamps'
        comment:
          maxLength: 200
          minLength: 0
          type: string
        taxNumber:
          type: string
          description: An (Optional) tax number to be associated with the customer
      description: The buyer. All transactions are associated with a customer
      x-apidog-orders:
        - complytId
        - externalId
        - source
        - name
        - address
        - email
        - customerType
        - internalTimestamps
        - externalTimestamps
        - comment
        - taxNumber
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    externalTimestamps:
      required:
        - createdDate
        - updatedDate
      type: object
      properties:
        createdDate: &ref_0
          $ref: '#/components/schemas/timestamp'
          description: The creation time of the transaction
        updatedDate: *ref_0
      description: >-
        External timestamps, which should reference the dates in your
        originating system since these are the timestamps used for sales tax
        calculation
      x-apidog-orders:
        - createdDate
        - updatedDate
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    timestamp:
      type: string
      description: >-
        valid ISO8601 format. Supported formats are 'YYYY-MM-DD'/
        'YYYY-MM-DDTHH:mm:ssZ'/ and 'YYYY-MM-DDTHH:mm:ss±hh:mm' (with a valid
        time zone offset).
      x-apidog-folder: ''
    internalTimestamps:
      required:
        - createdDate
        - updatedDate
      type: object
      properties:
        createdDate: *ref_0
        updatedDate: *ref_0
      description: read-only. The APIs internal timestamps for this resource
      x-apidog-orders:
        - createdDate
        - updatedDate
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    addressOfCustomer:
      type: object
      properties:
        city: *ref_1
        country: *ref_2
        county: *ref_3
        state: *ref_4
        street: *ref_5
        region: *ref_6
        zip: *ref_7
        isPartial:
          type: boolean
      description: The customer's Address
      x-apidog-orders:
        - city
        - country
        - county
        - state
        - street
        - region
        - zip
        - isPartial
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: https://sandbox.complyt.io
    description: SandBox
security: []

```