# API: Get client emails

# getClientEmails

Get list of emails sent to client.

TIP

This API call uses pagination for results.

# Required parameters

Parameter Description
id Client ID

# Optional parameters

Parameter Description
page Which page to return
filter[lastname] Filter by client last name
filter[subject] Filter by email subject
filter[email] Filter by client email
filter[message] Filter by email message
filter[rel_type] Filter by email type values: [client, contact, account, domain, order, invoice, estimate, ticket]
filter[rel_id] Filter by email related id
filter[status] Filter by email status values: [0, 1]

# Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=getClientEmails&id=ID

# PHP Samples

# Response

{
    "success": true,
    "emails": [
        {
            "id": "165",
            "client_id": "3",
            "subject": "New Hosting Account Created",
            "date": "2011-07-18 13:11:05",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "164",
            "client_id": "3",
            "subject": "New Order #1939512264",
            "date": "2011-07-18 13:10:12",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "163",
            "client_id": "3",
            "subject": "Invoice #89: Created",
            "date": "2011-07-18 13:10:12",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "158",
            "client_id": "3",
            "subject": "New Hosting Account Created",
            "date": "2011-07-18 12:49:03",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "157",
            "client_id": "3",
            "subject": "New Order #867385070",
            "date": "2011-07-18 12:48:38",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "156",
            "client_id": "3",
            "subject": "Invoice #87: Created",
            "date": "2011-07-18 12:48:38",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "133",
            "client_id": "3",
            "subject": "New Order #955986012",
            "date": "2011-07-15 14:07:21",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "132",
            "client_id": "3",
            "subject": "Invoice #76: Created",
            "date": "2011-07-15 14:07:21",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "99",
            "client_id": "3",
            "subject": "Invoice #60: Created",
            "date": "2011-07-13 05:32:04",
            "lastname": "Doe",
            "firstname": "John"
        },
        {
            "id": "82",
            "client_id": "3",
            "subject": "Invoice #48: Created",
            "date": "2011-07-06 04:17:56",
            "lastname": "Doe",
            "firstname": "John"
        }
    ],
    "totalpages": 4,
    "call": "getClientEmails",
    "server_time": 1317711909
}
Last Updated: 1/2/2024, 3:19:45 PM