PApaymongo
Contacts

List contacts

List contacts with optional filters and cursor pagination.

get/v1/contacts

Request

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

Query parameters

cursorstring

Cursor from previous response

limitinteger

Page size (default 20)

idsstring[]

Filter by contact IDs (repeatable)

owner_idsstring[]

Filter by record owner IDs (repeatable)

statusstring[]

Filter by contact status (repeatable)

metadata_statusstring[]

Filter by metadata.status (repeatable)

include_archivedboolean

Include archived contacts

email_searchstring

Search by email

email_search_modestring

Email search mode: exact or prefix

phone_searchstring

Search by phone (E.164)

created_at_fromstring

created_at lower bound (RFC3339)

created_at_tostring

created_at upper bound (RFC3339)

updated_at_fromstring

updated_at lower bound (RFC3339)

updated_at_tostring

updated_at upper bound (RFC3339)

last_contacted_at_fromstring

last_contacted_at lower bound (RFC3339)

last_contacted_at_tostring

last_contacted_at upper bound (RFC3339)

Response

OK

cursorstring
has_moreboolean

Example response

{
  "cursor": "MjAyNi0wNy0wMlQxMDowMDowMFp8Y250XzAxMjM0NTY3ODlhYmNkZWYwMTIzNDU2Nw==",
  "data": [
    {
      "attributes": {
        "address": {
          "city": "Makati",
          "country": "PH",
          "line_1": "123 Ayala Ave",
          "line_2": "Unit 4B",
          "postal_code": "1226",
          "province": "Metro Manila"
        },
        "created_at": "2026-07-01 10:00:00+00:00",
        "description": "Lead from summer campaign",
        "email": [
          {
            "email": "juan@example.com",
            "type": "TO"
          }
        ],
        "first_name": "Juan",
        "last_name": "Dela Cruz",
        "middle_name": "Protacio",
        "phone": [
          "+639171234567"
        ],
        "role": "CEO",
        "status": "active",
        "suffix": "Jr.",
        "updated_at": "2026-07-01 10:00:00+00:00"
      },
      "id": "cnt_0123456789abcdef01234567"
    }
  ],
  "has_more": true,
  "meta": {
    "total_count": 42
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.