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

# List customers

> Requires `read:customers`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/customers
openapi: 3.0.0
info:
  title: Car Storage Software API
  version: 1.1.0
  description: >-
    Team-scoped REST API for Car Storage Software. Authenticate with a team API
    key (`Authorization: Bearer <key>` or `x-api-key: <key>`) created under
    Settings → Integrations → API. Keys carry granular `read:*` / `write:*`
    scopes; read never implies write.
servers:
  - url: https://www.carstoragesoftware.com
security: []
paths:
  /api/v1/customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: Requires `read:customers`.
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: updatedAfter
          in: query
        - schema:
            type: string
          required: false
          name: ids
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          required: false
          name: includeDeleted
          in: query
      responses:
        '200':
          description: customers returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CustomersResponse'
        '401':
          description: Missing, invalid, revoked, or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: API key missing required scope, or API disabled for team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1CustomersResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/V1Customer'
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
          maximum: 200
        total:
          type: integer
          minimum: 0
      required:
        - data
        - page
        - limit
        - total
    ApiError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          nullable: true
      required:
        - error
    V1Customer:
      type: object
      properties:
        id:
          type: string
          format: uuid
        teamId:
          type: string
          nullable: true
        userId:
          type: string
          nullable: true
        locationId:
          type: string
          nullable: true
          format: uuid
        firstName:
          type: string
        lastName:
          type: string
        companyName:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        address:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        zip:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        isActive:
          type: boolean
        deletedAt:
          type: string
          nullable: true
          format: date-time
        createdAt:
          type: string
          nullable: true
          format: date-time
        updatedAt:
          type: string
          nullable: true
          format: date-time
      required:
        - id
        - teamId
        - userId
        - locationId
        - firstName
        - lastName
        - companyName
        - email
        - phone
        - address
        - city
        - state
        - zip
        - country
        - isActive
        - deletedAt
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Team API key from Settings → Integrations. Use `Authorization: Bearer
        <key>` or `x-api-key`.

````

## Related topics

- [Work with customer type lists](/docs/contacts/work-with-customer-type-lists.md)
- [Invite a customer to the portal](/docs/contacts/invite-a-customer-to-the-portal.md)
- [List contacts](/docs/api-reference/contacts/list-contacts.md)
- [List appointments](/docs/api-reference/appointments/list-appointments.md)
- [List cars](/docs/api-reference/cars/list-cars.md)


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