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

# List Customers

> Retrieve customers for the authenticated instance

Returns a paginated list of customers belonging to the authenticated instance. By default, archived customers are excluded.

## Query Parameters

<ParamField query="search" type="string">
  Free-text search across customer fields.
</ParamField>

<ParamField query="includeArchived" type="string" default="false">
  Set to `true` to include archived customers in results.
</ParamField>

<ParamField query="limit" type="integer" default="100">
  Number of results per page.
</ParamField>

<ParamField query="offset" type="integer" default="0">
  Number of results to skip for pagination.
</ParamField>

## Response Fields

<ResponseField name="success" type="boolean">Request status</ResponseField>
<ResponseField name="data" type="array">Array of customer objects</ResponseField>

<ResponseField name="metadata" type="object">
  <Expandable>
    <ResponseField name="total" type="integer">Total matching customers</ResponseField>
    <ResponseField name="requestId" type="string">Unique request identifier</ResponseField>
    <ResponseField name="timestamp" type="string">ISO 8601 response timestamp</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.trusset.org/customers/api/manage?limit=20&search=acme" \
    -H "X-API-Key: trusset_abc123xy_secret..."
  ```

  ```typescript TypeScript theme={null}
  const params = new URLSearchParams({ limit: '20', search: 'acme' });

  const response = await fetch(
    `https://api.trusset.org/customers/api/manage?${params}`,
    { headers: { 'X-API-Key': 'trusset_abc123xy_secret...' } }
  );
  const { data: customers, metadata } = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.trusset.org/customers/api/manage',
      headers={'X-API-Key': 'trusset_abc123xy_secret...'},
      params={'limit': 20, 'search': 'acme'}
  )
  data = response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "success": true,
    "data": [
      {
        "id": "cust_abc123",
        "instanceId": "inst_xyz789",
        "walletAddress": "0xAbC123dEf456789012345678901234567890AbCd",
        "country": "DE",
        "investorType": "PROFESSIONAL",
        "status": "verified",
        "verifiedAt": "2025-03-01T10:00:00.000Z",
        "archived": false
      }
    ],
    "metadata": {
      "total": 1,
      "requestId": "550e8400-e29b-41d4-a716-446655440000",
      "timestamp": "2025-06-15T12:00:00.000Z"
    }
  }
  ```
</ResponseExample>