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

# List contacts

> The people an account has emailed with (from, to, cc, bcc of synced mail), most recent first; the account's own address is left out.



## OpenAPI

````yaml /api-reference/openapi.yaml get /contacts
openapi: 3.1.0
info:
  title: PigeonPost API
  version: 1.0.0
  description: >
    Connect your users' mailboxes (Gmail with an app password, and any IMAP/SMTP
    provider), read, send and manage their email, and

    receive webhooks when something changes. The API follows Unipile's v2
    conventions (ids, lists,

    events); its own version is v1.


    **Authentication:** every request needs your access token in the `X-API-KEY`
    header. Create

    tokens in your dashboard under **API keys**, or with `POST
    /api/v1/api-keys`.


    **Base URL:** `https://{your DSN}/api/v1`. Your DSN is shown in your
    dashboard.


    **Ids** carry their type: `acc_…` (account), `email_…`, `att_…`
    (attachment), `fld_…`

    (folder), `drf_…` (draft), `we_…` (webhook endpoint), `evt_…` (event),
    `pk_…` (API key).


    **Lists** are `{ "object": "<Plural>", "data": [...], "has_more": true|false
    }`. Accounts,

    webhook endpoints, conversations and API keys page with `offset` and
    `limit`. Emails, drafts

    and contacts page with a `cursor`: pass the `cursor` of a response back to
    get the next page.


    **Errors** always have the same JSON shape: `status`, `type`, `title`,
    `detail`.
servers:
  - url: https://{dsn}/api/v1
    description: Your workspace's DSN, from your dashboard
    variables:
      dsn:
        default: mail-api.example.com
        description: Your DSN, for example mail-api.example.com
security:
  - apiKey: []
tags:
  - name: Auth
    description: Connect a mailbox from your app (IMAP/SMTP).
  - name: Accounts
    description: The mailboxes connected to your workspace.
  - name: Emails
    description: Read, search, send, change and delete emails.
  - name: Attachments
    description: Download the files attached to an email.
  - name: Drafts
    description: Drafts saved in the user's mailbox.
  - name: Folders
    description: Folders (Gmail labels appear as folders over IMAP).
  - name: Contacts
    description: The people an account has emailed with.
  - name: Webhooks
    description: Get notified when something happens in a mailbox.
  - name: API keys
    description: Access tokens for this API.
paths:
  /contacts:
    get:
      tags:
        - Contacts
      summary: List contacts
      description: >-
        The people an account has emailed with (from, to, cc, bcc of synced
        mail), most recent first; the account's own address is left out.
      operationId: listContacts
      parameters:
        - name: account_id
          in: query
          schema:
            type: string
        - name: q
          in: query
          description: Search the address and the name.
          schema:
            type: string
          example: ana
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/cursor'
      responses:
        '200':
          description: The contacts.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    const: Contacts
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          const: Contact
                        account_id:
                          type: string
                        identifier:
                          type: string
                          format: email
                          description: The address (lowercase).
                        display_name:
                          type: string
                          description: The name from their latest email.
                        emails_count:
                          type: integer
                        last_email_at:
                          type: string
                          format: date-time
                  has_more:
                    type: boolean
                  cursor:
                    type:
                      - string
                      - 'null'
              example:
                object: Contacts
                data:
                  - object: Contact
                    account_id: acc_ba1fa6938d8548298e8ce62e4b4b4e99
                    identifier: ana@example.com
                    display_name: Ana Lee
                    emails_count: 42
                    last_email_at: '2026-10-06T09:12:00Z'
                has_more: false
                cursor: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    limit:
      name: limit
      in: query
      description: How many items per page, 1 to 250.
      schema:
        type: integer
        minimum: 1
        maximum: 250
        default: 50
    cursor:
      name: cursor
      in: query
      description: The `cursor` from the previous page. Leave it out for the first page.
      schema:
        type: string
  responses:
    BadRequest:
      description: A parameter is missing or wrong. `detail` says which.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 400
            type: errors/invalid_parameters
            title: Invalid parameters
            detail: limit must be between 1 and 250
    Unauthorized:
      description: The `X-API-KEY` header is missing, wrong or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 401
            type: errors/unauthorized
            title: Unauthorized
            detail: missing or invalid API key
  schemas:
    Error:
      type: object
      properties:
        status:
          type: integer
        type:
          type: string
          enum:
            - errors/invalid_parameters
            - errors/unauthorized
            - errors/invalid_credentials
            - errors/not_found
            - errors/already_exists
            - errors/provider_rejected
            - errors/provider_error
            - errors/unexpected_error
        title:
          type: string
        detail:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Your access token, from your dashboard under **API keys**.

````

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