Email Lists
List email lists
List email lists, newest first. Filter by purpose and organization_id, or set global=true for lists without an organization. Internal callers only.
get/v1/email_lists
Request
- Base URLhttps://contacts-api.paymongo.com
- URLhttps://contacts-api.paymongo.com/v1/email_lists
- Auth
- HTTP basic
- or HTTP bearer
Query parameters
purposestring
Purpose
organization_idstring
Organization ID
globalboolean
Only lists without an organization
limitinteger
Page size, 1-100 (default 20)
cursorstring
Cursor from the previous page
Response
OK
Example response
{
"cursor": "MjAyNi0xMC0yM1QwODowMDowMFp8ZW1sXzNmOWExYzdlNWIyZDRhNmM4ZTBmMWEyYg==",
"data": [
{
"attributes": {
"created_at": "2026-10-23 08:00:00+00:00",
"created_by": "admin_123",
"description": "Recipients of dispute notification emails",
"entries": [
{
"email": "disputes@example.com",
"name": "Disputes team"
}
],
"max_entries": 50,
"merchant_visibility": "editable",
"organization_id": "org_123",
"purpose": "disputes",
"updated_at": "2026-10-23 08:00:00+00:00",
"updated_by": "admin_123"
},
"id": "eml_3f9a1c7e5b2d4a6c8e0f1a2b",
"type": "email_list"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.