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

# List contacts

> Returns a paginated list of contacts scoped to your company. All filter params are optional and ANDed together.




## OpenAPI

````yaml /openapi.yaml get /api/contacts
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.1'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/contacts:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: >
        Returns a paginated list of contacts scoped to your company. All filter
        params are optional and ANDed together.
      operationId: listContacts
      parameters:
        - name: page
          in: query
          required: true
          schema:
            type: integer
            minimum: 0
          description: Zero-based page index.
        - name: contact_type
          in: query
          schema:
            type: string
          description: Filter by contact type name.
        - name: email
          in: query
          schema:
            type: string
          description: Filter by exact email address (case-insensitive).
        - name: phone
          in: query
          schema:
            type: string
          description: Filter by phone number (digits only, partial match).
        - name: name
          in: query
          schema:
            type: string
          description: Filter by full name (case-insensitive, all words must match).
        - name: updated_after
          in: query
          schema:
            type: string
            format: date-time
          description: Return only contacts updated after this ISO 8601 timestamp.
        - name: updated_before
          in: query
          schema:
            type: string
            format: date-time
          description: Return only contacts updated before this ISO 8601 timestamp.
      responses:
        '200':
          description: Paginated contact list.
          headers:
            x-offset:
              schema:
                type: integer
              description: Current page index.
            x-count:
              schema:
                type: integer
              description: Total matching contacts.
            x-size:
              schema:
                type: integer
              description: Page size.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                  count:
                    type: integer
                  page:
                    type: integer
                  pageSize:
                    type: integer
        '400':
          description: Missing or invalid parameters.
        '401':
          description: Invalid or missing API key.
      security:
        - ApiKeyHeader: []
        - DelegateToken: []
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    DelegateToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Delegate token issued by the platform. Format: `DelegateToken <token>`'

````

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