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

Parameter	Data type	Required?	Description
by-user-reference	string	no	filter the results by user reference

Request Body Parameters

none

Response Body Parameters

Parameter	Data type	Required?	Description
data	array	yes	Customers objects
id	string	yes	Customer ID. You will use this ID across all endpoints
user_reference	string	yes	User reference provided in request body

Request example

1
2
3

curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers?by-user-reference={user_reference}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'

Response example

{ 
"data": [
        {
            "id": "12345",
            "user_reference": "{user_reference}"
        }]
}

Was this article helpful?

Friendly Score UK Ltd.

84 Brook Street

London W1K 5EH

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: 821100, 781963)