> ## 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 Periods

> Get all reporting periods for a sold product

# List Periods

Retrieve all reporting periods for a specific sold product. Each period represents a time range for which sales data and emissions are tracked.

## 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>

### Path Parameters

<ParamField path="sold_product_id" type="string" required>
  UUID of the sold product

  **Example:** `"550e8400-e29b-41d4-a716-446655440000"`
</ParamField>

## Response

Returns a list of periods (HTTP 200).

<ResponseField name="items" type="array[object]">
  List of reporting periods.

  <Expandable title="Period Object">
    <ResponseField name="id" type="string">
      Period UUID.
    </ResponseField>

    <ResponseField name="start_date" type="date">
      Period start date (ISO 8601 date).
    </ResponseField>

    <ResponseField name="end_date" type="date">
      Period end date (ISO 8601 date).
    </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/550e8400-e29b-41d4-a716-446655440000/periods" \
    -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/550e8400-e29b-41d4-a716-446655440000/periods",
      headers=headers,
  )

  periods = response.json()
  for period in periods["items"]:
      print(f"Period {period['id']}: {period['start_date']} to {period['end_date']}")
  ```

  ```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/550e8400-e29b-41d4-a716-446655440000/periods',
    { headers }
  )
  .then(response => {
    response.data.items.forEach(p =>
      console.log(`${p.start_date} to ${p.end_date}`)
    );
  });
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "items": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "start_date": "2024-01-01",
      "end_date": "2024-06-30"
    },
    {
      "id": "22222222-2222-2222-2222-222222222222",
      "start_date": "2024-07-01",
      "end_date": "2024-12-31"
    }
  ]
}
```

## 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"}
```

### 404 Not Found

**Cause:** Product does not exist or does not belong to your organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": "Not found."
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Check Period Overlap" icon="circle-exclamation" href="/api-reference/sold-products/check-overlap">
    Verify if a date range overlaps existing periods
  </Card>

  <Card title="Period Country Sales" icon="earth-americas" href="/api-reference/sold-products/country-sales">
    Get country-level sales breakdown for a period
  </Card>
</CardGroup>
