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

# Get Contacts

> Get paginated list of contacts with optional search. Staff/Administrator only.



## OpenAPI

````yaml /api/openapi-cutmake.json get /contacts
openapi: 3.1.0
info:
  title: VM App API
  version: 0.1.0
servers:
  - url: https://vinmake-erp.onrender.com
security: []
paths:
  /contacts:
    get:
      tags:
        - Master Data
      summary: Get Contacts
      description: >-
        Get paginated list of contacts with optional search. Staff/Administrator
        only.
      operationId: get_contacts_contacts_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Items per page
            default: 10
            title: Limit
          description: Items per page
        - name: sort
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Sort field with direction
            default: '-client_name'
            title: Sort
          description: Sort field with direction
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                minLength: 2
              - type: 'null'
            description: Search by client/company name
            title: Q
          description: Search by client/company name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedContactInfoResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    PaginatedContactInfoResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ContactInfoResponse'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/core__pagination__PaginationInfo'
      type: object
      required:
        - data
        - pagination
      title: PaginatedContactInfoResponse
      description: Paginated response for contact info list
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ContactInfoResponse:
      properties:
        id:
          type: string
          title: Id
        clientId:
          type: string
          title: Clientid
        clientName:
          type: string
          title: Clientname
        companyName:
          type: string
          title: Companyname
        contact1:
          type: string
          title: Contact1
        contact2:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact2
      type: object
      required:
        - id
        - clientId
        - clientName
        - companyName
        - contact1
      title: ContactInfoResponse
      description: Schema for contact info response - uses camelCase per API_STANDARDS
    core__pagination__PaginationInfo:
      properties:
        page:
          type: integer
          title: Page
        limit:
          type: integer
          title: Limit
        total:
          type: integer
          title: Total
        totalPages:
          type: integer
          title: Totalpages
        hasNext:
          type: boolean
          title: Hasnext
        hasPrev:
          type: boolean
          title: Hasprev
      type: object
      required:
        - page
        - limit
        - total
        - totalPages
        - hasNext
        - hasPrev
      title: PaginationInfo
      description: |-
        Pagination metadata following API standards.

        Attributes:
            page: Current page number (1-indexed)
            limit: Items per page
            total: Total number of items matching query
            totalPages: Total number of pages
            hasNext: Whether there is a next page
            hasPrev: Whether there is a previous page
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/login

````