Get customers

GET

/public/v3/customers

Retrieve a list of all your customers. You can filter the results by query parameter by-user-reference to find a particular customer.

Parameters

none

Query parameters

ParameterData typeRequired?Description
by-user-referencestringnofilter the results by user reference

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
dataarrayyesCustomers objects
idstringyesCustomer ID. You will use this ID across all endpoints
user_referencestringyesUser reference provided in request body

Request example

1 curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers?by-user-reference={USER_REFERENCE}'

Response example

1 2 3 4 5 6 7 { "data": [ { "id": "12345", "user_reference": "{USER_REFERENCE}" }] }

Was this article helpful?

Friendly Score UK Ltd.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 781963)