Search Customers

GET

https://api.devfluveo.com/v1/customers/search

GET

/v1/customers/search

curl -G https://api.devfluveo.com/v1/customers/search \
     -u "<username>:<password>" \
     -d query=query

200Retrieved

{
  "data": [
    {
      "created": 1,
      "default_source": "string",
      "description": "string",
      "email": "string",
      "id": "string",
      "livemode": true,
      "object": "customer",
      "shipping": {},
      "address": {
        "city": "string",
        "country": "string",
        "line1": "string",
        "line2": "string",
        "postal_code": "string",
        "state": "string"
      },
      "balance": 1,
      "business_name": "string",
      "cash_balance": {},
      "currency": "string",
      "customer_account": "string",
      "delinquent": true,
      "discount": {},
      "individual_name": "string",
      "invoice_credit_balance": {},
      "invoice_prefix": "string",
      "invoice_settings": {
        "custom_fields": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "default_payment_method": "string",
        "footer": "string",
        "rendering_options": {
          "amount_tax_display": "string",
          "template": "string"
        }
      },
      "metadata": {},
      "name": "string",
      "next_invoice_sequence": 1,
      "phone": "string",
      "preferred_locales": [
        "string"
      ],
      "sources": {
        "data": [
          {}
        ],
        "has_more": true,
        "object": "list",
        "url": "string"
      },
      "subscriptions": {
        "data": [
          {}
        ],
        "has_more": true,
        "object": "list",
        "url": "string"
      },
      "tax": {},
      "tax_exempt": "exempt",
      "tax_ids": {
        "data": [
          {}
        ],
        "has_more": true,
        "object": "list",
        "url": "string"
      },
      "test_clock": "string"
    }
  ],
  "has_more": true,
  "next_page": "string",
  "object": "search_result",
  "url": "string"
}

Authentication

AuthorizationBasic

Standard Basic HTTP authentication. The username is the Fluveo secret key and the password must be empty, encoded as base64(api_key:).

AuthorizationBearer

Bearer HTTP authentication. Allowed header: Authorization: Bearer <api_key>.

Query parameters

limitintegerOptional

pagestringOptional<=5000 characters

The next_page value of the previous search result.

querystringRequired<=5000 characters

Stripe's search query language over email, name, phone, metadata and created.

Response

Stripe-compatible response

datalist of objects

has_moreboolean

next_pagestring or null<=5000 characters

objectenum

Allowed values:

urlstring<=5000 characters