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

# Get Contacts

> List the contacts on your Novacal account, with search by name or email and pagination metadata.

## What this endpoint returns

This endpoint returns your contacts. Results are always paginated: the contacts for the current page live in `data.data`, alongside `current_page`, `per_page`, and `total`.

## Filtering and pagination

| Parameter  | Description                                                   |
| ---------- | ------------------------------------------------------------- |
| `query`    | Return only contacts whose name or email contains this string |
| `page`     | The page of results to return. Defaults to `1`                |
| `per_page` | Contacts per page, between 1 and 100. Defaults to `15`        |

## Common use cases

* Sync your Novacal contacts into a CRM
* Look up a contact by email before creating a booking
* Build an internal address book from your bookers


## OpenAPI

````yaml GET /v1/contacts
openapi: 3.1.0
info:
  title: Events API
  description: Public API for managing event types
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.novacal.io
security:
  - bearerAuth: []
paths:
  /v1/contacts:
    get:
      description: >-
        Returns a paginated list of the authenticated user's contacts. Supports
        searching by name or email.
      parameters:
        - name: query
          in: query
          description: Filter contacts whose name or email contains this string.
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: The page of results to return. Defaults to `1`.
          required: false
          schema:
            type: integer
            minimum: 1
            example: 1
        - name: per_page
          in: query
          description: >-
            The number of contacts per page, between 1 and 100. Defaults to
            `15`.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            example: 15
      responses:
        '200':
          description: Paginated contacts response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactsResponse'
components:
  schemas:
    ContactsResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          description: Indicates whether the request was successful
          type: boolean
          example: true
        data:
          type: object
          properties:
            current_page:
              type: integer
              example: 1
            data:
              type: array
              items:
                $ref: '#/components/schemas/Contact'
            per_page:
              type: integer
              example: 15
            total:
              type: integer
              example: 42
    Contact:
      type: object
      properties:
        id:
          description: The unique identifier of the contact
          type: string
          format: uuid
        name:
          description: The contact's name
          type:
            - string
            - 'null'
          example: Ada Lovelace
        email:
          description: The contact's email address
          type: string
          format: email
          example: ada@example.com
        timezone:
          description: The contact's timezone
          type:
            - string
            - 'null'
          example: Europe/London
        created_at:
          description: The date and time the contact was created
          type: string
          format: date-time
        updated_at:
          description: The date and time the contact was last updated
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````