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

# List Sonny's customers

> Provider-specific resource available only when the authenticated organization is backed by the supported Sonny's Shared data source. An unavailable provider returns the documented 400 or 404 response. Availability is determined server-side; credentials, connection details, and provider configuration are never returned.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/pos/sonnys/customers
openapi: 3.1.0
info:
  title: Nautilus Public API
  version: 1.0.0
  description: >-
    Tenant-scoped public API. Except for /api/v1/openapi.json, requests use a
    Clerk tenant API key as a Bearer token. The key's organizationId is the sole
    tenant scope; organization IDs supplied by callers are never accepted.
    Detail endpoints deliberately return 404 for both missing and cross-tenant
    records. Canonical collections use the standard envelope and endpoint-bound
    cursor pagination. Timestamps are UTC ISO 8601 values and monetary amounts
    ending in Cents are integer cents. Responses use narrow serializers and
    exclude credentials, API keys, provider configuration, access tokens,
    webhook secrets, raw provider payloads, and internal workflow or activity
    data.
servers:
  - url: https://app.nautilus.co
security:
  - tenantApiKey: []
tags:
  - name: Contract
  - name: Cancellations
  - name: Sites
  - name: Products
  - name: Checkout links
  - name: Purchases
  - name: Contact lists
  - name: Contacts
  - name: Marketing
  - name: Forms
  - name: Vouchers
  - name: Links
  - name: Automations
  - name: Surveys
  - name: Cases
  - name: Sonny's POS
  - name: Analytics
  - name: Messaging
  - name: Legacy
    description: Deprecated noncanonical endpoints retained for compatibility.
paths:
  /api/v1/pos/sonnys/customers:
    get:
      tags:
        - Sonny's POS
      summary: List Sonny's customers
      description: >-
        Provider-specific resource available only when the authenticated
        organization is backed by the supported Sonny's Shared data source. An
        unavailable provider returns the documented 400 or 404 response.
        Availability is determined server-side; credentials, connection details,
        and provider configuration are never returned.
      operationId: listSonnysCustomers
      parameters:
        - name: customerNumber
          in: query
          required: false
          schema:
            type: string
        - name: email
          in: query
          required: false
          schema:
            type: string
        - name: phone
          in: query
          required: false
          schema:
            type: string
        - name: active
          in: query
          required: false
          schema:
            type: boolean
          description: Filter active customers.
        - name: modifiedAfter
          in: query
          required: false
          schema:
            type: string
            format: date-time
            description: UTC ISO 8601 timestamp.
          description: >-
            Inclusive modification lower bound. Must include an explicit UTC
            offset.
        - name: modifiedBefore
          in: query
          required: false
          schema:
            type: string
            format: date-time
            description: UTC ISO 8601 timestamp.
          description: >-
            Inclusive modification upper bound. Must include an explicit UTC
            offset.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
          description: >-
            Page size. Invalid values use 100; values above 500 are capped at
            500.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Opaque continuation token returned by this Sonny's customers
            collection. Cursors are bound to this endpoint (and, for nested or
            sorted collections, to that parent or sort) and cannot be reused
            elsewhere.
      responses:
        '200':
          description: Tenant-scoped collection.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CollectionEnvelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/SonnysCustomer'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    CollectionEnvelope:
      type: object
      additionalProperties: false
      properties:
        organizationId:
          type: string
        filters:
          type: object
          additionalProperties: true
          description: Normalized filters actually applied to the request.
        data:
          type: array
          items: {}
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - organizationId
        - filters
        - data
        - pagination
      description: Standard envelope for canonical collection endpoints.
    SonnysCustomer:
      type: object
      additionalProperties: false
      properties:
        customerId:
          type: string
        customerNumber:
          anyOf:
            - type: string
            - type: 'null'
        firstName:
          anyOf:
            - type: string
            - type: 'null'
        lastName:
          anyOf:
            - type: string
            - type: 'null'
        companyName:
          anyOf:
            - type: string
            - type: 'null'
        birthDate:
          anyOf:
            - type: string
              format: date
            - type: 'null'
        contact:
          type: object
          additionalProperties: false
          properties:
            email:
              anyOf:
                - type: string
                - type: 'null'
            phone:
              anyOf:
                - type: string
                - type: 'null'
            allowSms:
              anyOf:
                - type: boolean
                - type: 'null'
          required:
            - email
            - phone
            - allowSms
        address:
          type: object
          additionalProperties: false
          properties:
            line1:
              anyOf:
                - type: string
                - type: 'null'
            line2:
              anyOf:
                - type: string
                - type: 'null'
            city:
              anyOf:
                - type: string
                - type: 'null'
            state:
              anyOf:
                - type: string
                - type: 'null'
            postalCode:
              anyOf:
                - type: string
                - type: 'null'
            country:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - line1
            - line2
            - city
            - state
            - postalCode
            - country
        active:
          anyOf:
            - type: boolean
            - type: 'null'
        loyaltyNumber:
          anyOf:
            - type: string
            - type: 'null'
        loyaltySmsSignupAt:
          anyOf:
            - type: string
              format: date-time
              description: UTC ISO 8601 timestamp.
            - type: 'null'
        recurringSmsSignupAt:
          anyOf:
            - type: string
              format: date-time
              description: UTC ISO 8601 timestamp.
            - type: 'null'
        modifiedAt:
          anyOf:
            - type: string
              format: date-time
              description: UTC ISO 8601 timestamp.
            - type: 'null'
        createdAt:
          anyOf:
            - type: string
              format: date-time
              description: UTC ISO 8601 timestamp.
            - type: 'null'
      required:
        - customerId
        - customerNumber
        - firstName
        - lastName
        - companyName
        - birthDate
        - contact
        - address
        - active
        - loyaltyNumber
        - loyaltySmsSignupAt
        - recurringSmsSignupAt
        - modifiedAt
        - createdAt
    Pagination:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
        hasMore:
          type: boolean
        nextCursor:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - limit
        - hasMore
        - nextCursor
    Error:
      type: object
      additionalProperties: false
      properties:
        error:
          type: string
      required:
        - error
  responses:
    BadRequest:
      description: >-
        Malformed parameters, unsupported provider, or unavailable resource for
        this organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, invalid, legacy, or non-tenant Bearer credential.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: >-
        The resource does not exist, is unavailable, or belongs to another
        organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error. No internal exception data is exposed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    tenantApiKey:
      type: http
      scheme: bearer
      bearerFormat: Clerk tenant API key
      description: >-
        Clerk tenant API key. The organizationId encoded by the key is the exact
        and only tenant scope.

````