Popular

↑↓ move ↵ open All results →

Integration API · Customers

Get a customer

GEThttps://{store}/api/v1/integrations/customers/{id}

One customer account with the fields of the list, its addresses and its 20 most recent placed orders.

Integration key with the customers:read ability: Authorization: Bearer {key}.

Path parameters

idintegerrequired
The customer id.

Responses

200The customer.
{
    "data": {
        "id": 318,
        "first_name": "Олена",
        "last_name": "Коваль",
        "company_name": null,
        "email": "[email protected]",
        "orders_count": 3,
        "created_at": "2026-09-14 11:02:40",
        "updated_at": "2026-10-12 14:03:11",
        "addresses": [
            {
                "first_name": "Олена",
                "last_name": "Коваль",
                "company_name": null,
                "line_one": "Відділення №1",
                "line_two": null,
                "city": "Київ",
                "postcode": "01001",
                "country": "UA",
                "contact_email": "[email protected]",
                "contact_phone": "+380671234567",
                "shipping_default": true
            }
        ],
        "recent_orders": [
            {
                "reference": "2026-001044",
                "status": "dispatched",
                "total": 214000,
                "currency_code": "UAH",
                "placed_at": "2026-10-12 14:03:11"
            }
        ]
    }
}
404No customer with this id.
{
    "code": "not_found",
    "message": "not_found",
    "field": null
}
401Missing, unknown or revoked key.
{
    "code": "unauthenticated",
    "message": "Integration key is inactive.",
    "field": null
}
403The key lacks customers:read, or the store’s plan has no API access.
{
    "code": "forbidden",
    "message": "Integration key cannot customers:read.",
    "field": null
}
422A field is invalid; field names it.
{
    "code": "validation_error",
    "message": "name is required.",
    "field": "name"
}
429More than 60 requests a minute for this key. Wait Retry-After seconds.
{
    "code": "rate_limited",
    "message": "Too many integration requests.",
    "field": null
}