<- Customers API

Customers API

Bulk retrieve customers



Retrieves multiple customer profiles.

This endpoint takes a list of customer IDs and returns a map of responses.

Try in API Explorer
Link to section

Request body

Example code

Link to section


string [ ]


Link to section

Response fields

Link to section


A map of responses that correspond to individual retrieve requests, represented by key-value pairs.

Each key is the customer ID that was specified for a retrieve request and each value is the corresponding response. If the request succeeds, the value is the requested customer profile. If the request fails, the value contains any errors that occurred during the request.

Link to section


Any top-level errors that prevented the bulk operation from running.