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

# List Sold Products

> Retrieve all sold products for your organization with optional filtering

# List Sold Products

Retrieve all sold products for your organization. Optionally filter by product name.

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

### Query Parameters

<ParamField query="name" type="string">
  Filter products by name (case-insensitive contains match)

  **Example:** `"Compressor"`
</ParamField>

## Response

Returns a list of sold products (HTTP 200).

<ResponseField name="items" type="array[object]">
  List of sold products.

  <Expandable title="Product Object">
    <ResponseField name="product_id" type="string">
      Product UUID.
    </ResponseField>

    <ResponseField name="product_name" type="string">
      Display name of the product.
    </ResponseField>

    <ResponseField name="organization_id" type="string">
      UUID of the organization that owns this product.
    </ResponseField>

    <ResponseField name="organization_name" type="string">
      Name of the owning organization.
    </ResponseField>
  </Expandable>
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X GET "https://api.dcycle.io/v1/sold-products/?name=Compressor" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}"
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  headers = {
      "x-api-key": os.getenv("DCYCLE_API_KEY"),
      "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
  }

  response = requests.get(
      "https://api.dcycle.io/v1/sold-products/",
      headers=headers,
      params={"name": "Compressor"},
  )

  products = response.json()
  for product in products["items"]:
      print(f"{product['product_name']} ({product['product_id']})")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const headers = {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
  };

  axios.get('https://api.dcycle.io/v1/sold-products/', {
    headers,
    params: { name: 'Compressor' },
  })
  .then(response => {
    response.data.items.forEach(p => console.log(p.product_name));
  });
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "items": [
    {
      "product_id": "550e8400-e29b-41d4-a716-446655440000",
      "product_name": "Industrial Compressor X200",
      "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
      "organization_name": "Acme Manufacturing"
    },
    {
      "product_id": "660f9500-f30c-52e5-b827-557766551111",
      "product_name": "Mini Compressor M50",
      "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
      "organization_name": "Acme Manufacturing"
    }
  ]
}
```

## Common Errors

### 401 Unauthorized

**Cause:** Missing or invalid API key

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
```

### 403 Forbidden

**Cause:** The authenticated user is not a member of the organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Delete Sold Product" icon="trash" href="/api-reference/sold-products/delete">
    Remove a sold product and all related data
  </Card>

  <Card title="List Periods" icon="calendar" href="/api-reference/sold-products/list-periods">
    Get all periods for a sold product
  </Card>
</CardGroup>