# List the store platforms available

> Platforms configured on this deployment and how each connects: oauth (redirect to the platform), store_auth (redirect to the store, WooCommerce) or…

Source: https://docs.pidgely.com/api-reference/commerce/list-platforms/

`GET https://api.pidgely.com/commerce/platforms`

Platforms configured on this deployment and how each connects: `oauth` (redirect to the platform), `store_auth` (redirect to the store, WooCommerce) or `credentials` (keys typed by the merchant, VTEX). Unconfigured platforms are absent.

**Authorization:** `Bearer pdg_…`. An API key with `full_access`. A `sending_access` key gets `401 restricted_api_key`.

## Request

This endpoint is not in the [SDKs](https://docs.pidgely.com/sdks/) yet; call it over HTTP.

```bash tab="cURL"
curl -X GET 'https://api.pidgely.com/commerce/platforms' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"
```

## Response

`200 OK`

```json
{
  "data": [
    {
      "platform": "nuvemshop",
      "mode": "oauth",
      "fields": [
        "shop"
      ],
      "checkouts": false
    }
  ]
}
```

### Response fields

| Name | Type | Required | Description |
|---|---|---|---|
| `data` | object[] | Yes | Items of this page. |
| `data[].platform` | string | Yes | One of `nuvemshop`, `shopify`, `woocommerce`, `vtex`. |
| `data[].mode` | string | Yes | One of `oauth`, `store_auth`, `credentials`. |
| `data[].fields` | string[] | Yes | — |
| `data[].checkouts` | boolean | Yes | Abandoned checkouts are available. |

## Errors

Errors have the shape `{"statusCode", "name", "message"}`. See [Errors](https://docs.pidgely.com/errors/) for the full list.

| Status | Name | When |
|---|---|---|
| 401 | `missing_api_key`, `restricted_api_key` | No `Authorization: Bearer` header, or a `sending_access` key called an endpoint that needs `full_access`. |
| 429 | `rate_limit_exceeded` | Too many requests per second. Wait for `Retry-After` seconds. |