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

# Get contacts



## OpenAPI

````yaml /api-reference/openapi-v2.json get /contacts
openapi: 3.1.0
info:
  title: Heyy API
  version: 2.0.0
servers:
  - url: https://api.heyy.io/v2
security:
  - bearerAuth: []
paths:
  /contacts:
    get:
      summary: Get contacts
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: string
        - name: pageSize
          in: query
          required: false
          schema:
            type: string
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
            enum:
              - firstName
              - lastName
              - phoneNumber
              - createdAt
              - updatedAt
        - name: order
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
        - name: search
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      contacts:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            firstName:
                              type: string
                            lastName:
                              type: string
                            phoneNumber:
                              type: string
                            email:
                              type: string
                            labels:
                              type: array
                              items:
                                type: string
                            attributes:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                  value:
                                    type: string
                                required:
                                  - name
                                  - value
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                          required:
                            - id
                            - createdAt
                            - updatedAt
                    required:
                      - contacts
                required:
                  - success
                  - data
                additionalProperties: false
              example:
                success: true
                data:
                  contacts: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````