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

# List Customers

> Retrieve all customers in your workspace

## Authorization

<ParamField header="Authorization" type="string" required>
  Bearer token. Format: `Bearer qwoty_your_token`
</ParamField>

## Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl https://qwoty.app/api/customers \
    -H "Authorization: Bearer qwoty_your_token"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://qwoty.app/api/customers', {
    headers: { Authorization: 'Bearer qwoty_your_token' },
  })
  const data = await response.json()
  ```

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

  response = requests.get(
      'https://qwoty.app/api/customers',
      headers={'Authorization': 'Bearer qwoty_your_token'},
  )
  data = response.json()
  ```
</CodeGroup>

## Response

<ResponseField name="success" type="boolean">
  `true` if the request succeeded
</ResponseField>

<ResponseField name="data" type="array">
  Array of customer objects

  <Expandable title="Customer Object">
    <ResponseField name="id" type="string">UUID</ResponseField>
    <ResponseField name="workspace_id" type="string">Workspace UUID</ResponseField>
    <ResponseField name="name" type="string">Customer name</ResponseField>
    <ResponseField name="type" type="string">`company` or `individual`</ResponseField>
    <ResponseField name="segment_id" type="string | null">Segment UUID</ResponseField>
    <ResponseField name="logo" type="string | null">Logo URL</ResponseField>
    <ResponseField name="id_crm" type="string | null">External CRM ID</ResponseField>
    <ResponseField name="id_erp" type="string | null">External ERP ID</ResponseField>
    <ResponseField name="id_accounting" type="string | null">External accounting ID</ResponseField>
    <ResponseField name="contact_ids" type="string[]">Array of contact UUIDs linked to this customer. Use `GET /api/contacts/{id}` to fetch each contact.</ResponseField>
    <ResponseField name="address_ids" type="string[]">Array of address UUIDs linked to this customer. Use `GET /api/addresses/{id}` to fetch each address.</ResponseField>
    <ResponseField name="created_at" type="string">ISO 8601 timestamp</ResponseField>
    <ResponseField name="updated_at" type="string">ISO 8601 timestamp</ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Success Response theme={null}
  {
    "success": true,
    "data": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "workspace_id": "706eb564-6c4a-4e18-841c-bdd79be6bca7",
        "name": "Acme Corporation",
        "type": "company",
        "segment_id": null,
        "logo": null,
        "id_crm": "crm_001",
        "id_erp": null,
        "id_accounting": null,
        "contact_ids": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
        "address_ids": ["c3d4e5f6-a7b8-9012-cdef-123456789012"],
        "created_at": "2026-01-15T10:30:00Z",
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ]
  }
  ```
</ResponseExample>
