> ## 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 contacts

> Requires `read:contacts`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/contacts
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/contacts:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: Requires `read:contacts`.
      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
            format: uuid
          required: false
          name: customerId
          in: query
      responses:
        '200':
          description: contacts returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ContactsResponse'
        '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:
    V1ContactsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/V1Contact'
        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
    V1Contact:
      type: object
      properties:
        id:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        role:
          type: string
          enum:
            - primary
            - spouse
            - child
            - son
            - daughter
            - family_member
            - bookkeeper
            - vehicle_handler
            - family_office
            - accountant
            - assistant
            - collection_manager
            - other
        roleDescription:
          type: string
          nullable: true
        isPrimary:
          type: boolean
        canAccessPortal:
          type: boolean
        communicationPreferences:
          type: object
          nullable: true
          properties:
            invoices:
              type: boolean
            estimates:
              type: boolean
            scheduling:
              type: boolean
            carUpdates:
              type: boolean
            contracts:
              type: boolean
            socialEvents:
              type: boolean
            marketing:
              type: boolean
          required:
            - invoices
            - estimates
            - scheduling
            - carUpdates
            - contracts
            - socialEvents
            - marketing
        createdAt:
          type: string
          nullable: true
          format: date-time
        updatedAt:
          type: string
          nullable: true
          format: date-time
      required:
        - id
        - customerId
        - firstName
        - lastName
        - email
        - phone
        - role
        - roleDescription
        - isPrimary
        - canAccessPortal
        - communicationPreferences
        - 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

- [Invite a customer to the portal](/docs/contacts/invite-a-customer-to-the-portal.md)
- [Contacts overview](/docs/contacts/overview.md)
- [Work with vendor contacts](/docs/contacts/work-with-vendor-contacts.md)
- [Find and filter contacts](/docs/contacts/find-and-filter-contacts.md)
- [Work with customer type lists](/docs/contacts/work-with-customer-type-lists.md)


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