> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weflayr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get customers

> Get every known customer of the project, with its tags.

Get every known customer of the project, with its [customer tags](/product/customer-tags).

## Parameters

<ParamField query="include_customer_tags" type="boolean" default="true">
  Include each customer's tags. When `false`, `customer_tags` is an empty object.
</ParamField>

<ParamField query="limit" type="integer" default="100">
  Numbers of customers to fetch. Max `1000`.
</ParamField>

<ParamField query="cursor" type="string">
  The route is paginated: pass the previous page's `next_cursor` to fetch the next page. PS: `has_more` from the output says whether another page exists.
</ParamField>

<RequestExample>
  ```python Python theme={null}
  import weflayr

  client = weflayr.client()  # reads WEFLAYR_API_KEY

  client.get_customers(include_customer_tags=True)
  ```

  ```js Node.js theme={null}
  const weflayr = require('weflayr');

  const client = weflayr.client(); // reads WEFLAYR_API_KEY

  await weflayr.api.getCustomers({
    client,
    throwOnError: true,
    query: { includeCustomerTags: true },
  });
  ```

  ```bash cURL theme={null}
  curl "https://app.weflayr.com/api/customers/" \
    -H "Authorization: Bearer $WEFLAYR_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "customers": [
      {"customer_name": "c_123", "customer_tags": {"plan": "enterprise", "region": "EU"}},
      {"customer_name": "c_456", "customer_tags": {}}
    ],
    "next_cursor": null,
    "has_more": false
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.