# List products

`GET https://api.coach-platform.com/api/public/products`

List the current key's coach products. Filter by productType, isActive or name.

- Resource: Products
- Authentication: API key in the `Authorization: Bearer cp_live_...` header
- HTML version: https://www.coach-platform.com/docs/api/reference/get-products
- OpenAPI spec: https://www.coach-platform.com/openapi.json

## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `page` | integer | No | Page number (1-based, default 1) Minimum: `1`. |
| `limit` | integer | No | Number of items to return (default 25, max 500) Minimum: `1`. Maximum: `500`. |
| `productType` | string | No | Allowed values: `SINGLE`, `PUNCH_CARD`, `MEMBERSHIP`. |
| `isActive` | boolean | No |   |
| `name` | string | No | Case-insensitive name filter |

## Responses

| Status | Description |
|---|---|
| `200` OK | Successful response |
| `400` Bad Request |  |
| `401` Unauthorized |  |
| `403` Forbidden |  |
| `429` Too Many Requests |  |
| `500` Internal Server Error |  |

### 200 OK

Content type: `application/json`

| Field | Type | Description |
|---|---|---|
| `data` | object[] |   |
| `data[].id` | string |   |
| `data[].coachId` | string |   |
| `data[].name` | string |   |
| `data[].description` | string |   |
| `data[].price` | number |   |
| `data[].currency` | string | Allowed values: `ILS`, `USD`, `EUR`, `GBP`. |
| `data[].productType` | string | Allowed values: `SINGLE`, `PUNCH_CARD`, `MEMBERSHIP`. |
| `data[].productCategory` | string |   |
| `data[].credits` | number \| null |   |
| `data[].isActive` | boolean |   |
| `data[].hidePriceInApp` | boolean |   |
| `data[].membershipDetails` | object \| null |   |
| `data[].membershipDetails.duration` | object |   |
| `data[].membershipDetails.duration.value` | number |   |
| `data[].membershipDetails.duration.unit` | string | Allowed values: `DAY`, `WEEK`, `MONTH`, `YEAR`. |
| `data[].membershipDetails.recurrence` | string | Allowed values: `DAILY`, `WEEKLY`, `MONTHLY`, `YEARLY`, `ONE_TIME`. |
| `data[].membershipDetails.limitations` | object |   |
| `data[].membershipDetails.limitations.isUnlimited` | boolean |   |
| `data[].membershipDetails.limitations.periodicalUsage` | object |   |
| `data[].membershipDetails.limitations.periodicalUsage.usagesPerPeriod` | number |   |
| `data[].membershipDetails.limitations.periodicalUsage.periodType` | string |   |
| `data[].membershipDetails.limitations.allowedHours` | object |   |
| `data[].membershipDetails.limitations.allowedHours.from` | string |   |
| `data[].membershipDetails.limitations.allowedHours.to` | string |   |
| `data[].membershipDetails.limitations.allowedDays` | string[] |   |
| `data[].createdAt` | string<date-time> |   |
| `data[].updatedAt` | string<date-time> |   |
| `pagination` | object |   |
| `pagination.page` | number |   |
| `pagination.limit` | number |   |
| `pagination.total` | number \| null | Total number of matching items. null when the underlying source cannot report an exact count for this page; use hasMore to keep paging. |
| `pagination.hasMore` | boolean |   |
| `pagination.truncated` | boolean | Present and true when the result set exceeded the in-memory scan cap and was truncated. Narrow your filters to page through all items. |

Example:

```json
{
  "data": [
    {
      "id": "<string>",
      "coachId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "price": 123,
      "currency": "ILS",
      "productType": "SINGLE",
      "productCategory": "<string>",
      "credits": 123,
      "isActive": true,
      "hidePriceInApp": true,
      "membershipDetails": {
        "duration": {
          "value": 123,
          "unit": "DAY"
        },
        "recurrence": "DAILY",
        "limitations": {
          "isUnlimited": true,
          "periodicalUsage": {
            "usagesPerPeriod": 123,
            "periodType": "<string>"
          },
          "allowedHours": {
            "from": "<string>",
            "to": "<string>"
          },
          "allowedDays": [
            "<string>"
          ]
        }
      },
      "createdAt": "<date-time>",
      "updatedAt": "<date-time>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasMore": true,
    "truncated": true
  }
}
```

### Error responses 400, 401, 403, 429, 500

Content type: `application/json`

| Field | Type | Description |
|---|---|---|
| `error` | object |   |
| `error.code` | string |   |
| `error.message` | string |   |
| `error.fix` | string \| null |   |
| `error.details` | object \| null |   |
| `error.retryAfterMs` | number \| null |   |

Example:

```json
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}
```

## Examples

### cURL

```bash
curl --request GET \
  --url 'https://api.coach-platform.com/api/public/products' \
  --header 'Authorization: Bearer cp_live_...'
```

### JavaScript (fetch)

```js
const response = await fetch('https://api.coach-platform.com/api/public/products', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer cp_live_...',
  },
});

const data = await response.json();
```

## Related endpoints

- [Get a product](https://www.coach-platform.com/docs/api/reference/get-products-product-id/index.md): `GET /api/public/products/{productId}`. Get a product by id.
- Previous: [List employees](https://www.coach-platform.com/docs/api/reference/get-employees/index.md): `GET /api/public/employees`. List the coach's team members (employees), including name, phone, email, and role.
- Next: [Get a product](https://www.coach-platform.com/docs/api/reference/get-products-product-id/index.md): `GET /api/public/products/{productId}`. Get a product by id.