Skip to main content
GET
/
v1
/
customers
List all customers
curl --request GET \
  --url https://api.yorlet.com/v1/customers \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "customer",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "country": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
      },
      "default_payment_method": "<string>",
      "delinquent": true,
      "description": "<string>",
      "email": "[email protected]",
      "invoice_prefix": "<string>",
      "invoicing": {
        "arrears_emails": true,
        "email_cc": [
          "[email protected]"
        ],
        "email_to": "[email protected]"
      },
      "legal": {
        "dob": {
          "day": 16,
          "month": 6.5,
          "year": 5949.5
        },
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "name": "<string>",
      "phone": "<string>",
      "radar": {
        "message": "<string>",
        "reason": "<string>",
        "risk_level": "<string>"
      },
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of customers.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required