Partners

Get a customer with health

One customer with its sending health: status, who set any sending lock, its own 30-day bounce and complaint rates, per-domain reputation, and the sending tenant's state. Requires partner:read.

get/customers/{id}

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

Response

The customer and its health

successboolean

Example response

{
  "success": true,
  "data": {
    "id": "cmtumr8yj000bd7xabjjsnil8",
    "email": "owner@smiledental.example",
    "name": "Dana Levi",
    "companyName": "Smile Dental",
    "domains": 1,
    "mailboxes": 4,
    "domainList": [
      {
        "bounceRate": 0.004,
        "complaintRate": 0.004,
        "storage": {
          "usedBytes": 3221225472,
          "limitBytes": 53687091200,
          "availableBytes": 50465865728
        }
      }
    ],
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    },
    "rates": {
      "sends": 1240,
      "bounces": 5,
      "bounceRate": 0.004,
      "complaintRate": 0.004
    }
  }
}

Changes

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