---
title: "List contacts"
method: GET
path: "/v1/contacts"
tags: ["Contacts"]
---

# List contacts

`GET /v1/contacts`

## Request

- Base URL: `https://contacts-api.paymongo.com`
- URL: `https://contacts-api.paymongo.com/v1/contacts`
- Auth: HTTP basic

List contacts with optional filters and cursor pagination.

## Query parameters

- `cursor` string
- `limit` integer
- `ids` string[]
- `owner_ids` string[]
- `status` string[]
- `metadata_status` string[]
- `include_archived` boolean
- `email_search` string
- `email_search_mode` string
- `phone_search` string
- `created_at_from` string
- `created_at_to` string
- `updated_at_from` string
- `updated_at_to` string
- `last_contacted_at_from` string
- `last_contacted_at_to` string

## Response `200`

OK

- ContactListResponseDTO
  - `cursor` string
  - `data` ContactResponseDTO[]
    - `attributes` ContactAttributesDTO
      - `address` AddressDTO
        - `city` string
        - `country` string
        - `line_1` string
        - `line_2` string
        - `postal_code` string
        - `province` string
      - `created_at` string
      - `description` string
      - `email` EmailDTO[]
        - `email` string
        - `type` string
      - `first_name` string
      - `last_name` string
      - `metadata` object
      - `middle_name` string
      - `phone` string[]
      - `role` string
      - `status` string
      - `suffix` string
      - `updated_at` string
    - `id` string
  - `has_more` boolean
  - `meta` ContactListMetaDTO
    - `total_count` integer

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paymongo/apis/contacts-api.md) - [All operations](https://skmtc.dev/paymongo/apis/contacts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/contacts-api/revisions/b5416b944e43?raw)
