Skip to main content
GET
/
clients
/
me
/
integrations
/
meld
/
customers
Get Meld customer
curl --request GET \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/meld/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "customers": [
      {
        "id": "<string>",
        "accountId": "<string>",
        "externalId": "<string>",
        "name": {
          "firstName": "<string>",
          "lastName": "<string>"
        },
        "email": "<string>",
        "phone": "<string>",
        "dateOfBirth": "<string>",
        "type": "INDIVIDUAL",
        "status": "ACTIVE",
        "addresses": [
          {
            "id": "<string>",
            "customerId": "<string>",
            "type": "BILLING",
            "status": "ACTIVE",
            "addressDetails": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "region": "<string>",
              "postalCode": "<string>",
              "country": "<string>"
            }
          }
        ],
        "serviceProviders": {}
      }
    ],
    "count": 123,
    "remaining": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Response

Meld customer retrieved successfully

data
object