Skip to content

List customers

GET/customers

Costs 1 rate-limit point · Rate limits

Retrieve a paginated list of customers. Supports search by name, email, or tax number.

Query parameters

  • searchstring

    Search by name, email, or tax number.

  • pageinteger

    Page number.

    Default 1
  • per_pageinteger

    Items per page (max 250).

    Default 25

Returns

  • customersarray of objects
    Show 11 child attributesHide child attributes
    • idinteger
      Example: 9177
    • emailstring
      Example: jane.doe@example.com
    • first_namestring
      Example: Jane
    • last_namestring
      Example: Doe
    • phonestring
      Example: +1 555 010 0199
    • tax_numberstring

      VAT/GST/tax identification number.

    • eori_numberstring

      EU EORI number.

    • tagsstring
      Example: wholesale, newsletter
    • shopify_customer_idinteger
      Example: 7001234567
    • created_atstring
      Example: 2025-09-21T16:45:00Z
    • updated_atstring
      Example: 2026-01-15T09:30:00Z
  • metaobject
    Show 4 child attributesHide child attributes
    • totalinteger
      Example: 2
    • pageinteger
      Example: 1
    • per_pageinteger
      Example: 25
    • total_pagesinteger
      Example: 1

Errors

401

Missing or invalid API key.

403

The store is not on a paid plan. API access requires a paid Invoice Falcon plan.

429

Rate limit exceeded. Check X-RateLimit-Reset header.

GET/customers
curl "https://app.invoicefalcon.com/api/v1/external/customers" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "customers": [
    {
      "id": 9177,
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "phone": "+1 555 010 0199",
      "tax_number": "US-12-3456789",
      "eori_number": null,
      "tags": "wholesale, newsletter",
      "shopify_customer_id": 7001234567,
      "created_at": "2025-09-21T16:45:00Z",
      "updated_at": "2026-01-15T09:30:00Z"
    },
    {
      "id": 9203,
      "email": "sam.rivera@example.com",
      "first_name": "Sam",
      "last_name": "Rivera",
      "phone": null,
      "tax_number": null,
      "eori_number": null,
      "tags": "",
      "shopify_customer_id": 7001234999,
      "created_at": "2025-10-02T11:20:00Z",
      "updated_at": "2025-10-02T11:20:00Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "per_page": 25,
    "total_pages": 1
  }
}