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

# List all contacts



## OpenAPI

````yaml GET /contacts
openapi: 3.1.0
info:
  title: Caspen
  version: 0.0.1
servers:
  - url: https://api.caspen.com/v1
    description: Production
security: []
paths:
  /contacts:
    get:
      tags:
        - Contact
      operationId: contact.index
      parameters:
        - name: cursor
          in: query
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Paginated set of `ContactResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ContactCollection'
                  links:
                    type: object
                    properties:
                      prev:
                        type:
                          - string
                          - 'null'
                      next:
                        type:
                          - string
                          - 'null'
                    required:
                      - prev
                      - next
                required:
                  - data
                  - links
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    ContactCollection:
      type: array
      items:
        $ref: '#/components/schemas/ContactResource'
      title: ContactCollection
    ContactResource:
      type: object
      properties:
        id:
          type: string
          description: The contact's unique identifier.
          examples:
            - con_01HQFQ9QWTNNPY58FZ8CB3FWWK
        type:
          type:
            - string
            - 'null'
          description: The contact's type, derived from the contact type's name.
          examples:
            - third_party_payer
        title:
          type:
            - string
            - 'null'
          description: The contact's honorific title.
          examples:
            - Dr
        first_name:
          type: string
          description: The contact's given name.
          examples:
            - John
        last_name:
          type:
            - string
            - 'null'
          description: The contact's family name.
          examples:
            - Smith
        preferred_name:
          type:
            - string
            - 'null'
          description: The contact's preferred name.
          examples:
            - Johnny
        profession:
          type:
            - string
            - 'null'
          description: The contact's profession or occupation.
          examples:
            - General Practitioner
        company:
          type:
            - string
            - 'null'
          description: The contact's company or organization.
          examples:
            - City Medical Centre
        email:
          type:
            - string
            - 'null'
          description: The contact's email address.
          examples:
            - john.smith@citymedical.com
        notes:
          type:
            - string
            - 'null'
          description: The contact's notes.
          examples:
            - Preferred referrer for orthopedic cases.
        phone_numbers:
          type: array
          description: A list of the contact's phone numbers.
          examples:
            - - id: pho_01HQR12PABCD1234EFGH56789
                code: '+61'
                number: '400123456'
                type: mobile
          items:
            type: object
            properties:
              id:
                type: string
              code:
                type: string
              number:
                type: string
              type:
                type: string
        address:
          type:
            - object
            - 'null'
          description: The contact's address details.
          examples:
            - line1: 123 Medical Street
              line2: Suite 4
              city: Sydney
              state: NSW
              postal_code: '2000'
              country_code: AU
          properties:
            line1:
              type:
                - string
                - 'null'
            line2:
              type:
                - string
                - 'null'
            city:
              type:
                - string
                - 'null'
            state:
              type:
                - string
                - 'null'
            postal_code:
              type:
                - string
                - 'null'
            country_code:
              type:
                - string
                - 'null'
        tag_ids:
          type: array
          description: The IDs of tags attached to the contact.
          examples:
            - - tag_01HYHYQHA682J0K1RW7B2HVA9F
              - tag_01HYHYW37MTYJPMT5JV4RN99GK
          items:
            type: string
        created_at:
          type: string
          description: The timestamp when the contact was created (ISO 8601).
          examples:
            - '2024-01-01T12:00:00Z'
      title: ContactResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors

````