Skip to main content
GET
/
customers
/
List customers
curl --request GET \
  --url https://provider.api.nadles.com/v0/customers/ \
  --header 'nadles-provider-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "external_id": "<string>",
      "billing_address_line1": "<string>",
      "billing_address_line2": "<string>",
      "billing_address_city": "<string>",
      "billing_address_country_code": "<string>",
      "billing_address_zip_code": "<string>",
      "billing_address_region": "<string>",
      "is_business": true,
      "business_name": "<string>",
      "company_number": "<string>",
      "tax_identifier": "<string>"
    }
  ],
  "metadata": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "total": 123
    }
  }
}

Authorizations

nadles-provider-key
string
header
required

API key provided in the admin portal

Query Parameters

id
string

Filter by customer ID

externalId
string

Filter by external ID

name
string

Filter by customer name

email
string

Filter by customer email

offset
integer
default:0

Number of items to skip before starting to collect the result set

limit
integer
default:25

Maximum number of items to return

or
boolean
default:false

Use OR logic for filters instead of AND

sort
string

Sort order (e.g. created_at desc)

Response

200 - application/json

OK

data
object[]
metadata
object