---
title: "List the environments a template reaches"
url: https://docs.corefinity.com/api/reference/deployments/list-deploy-template-usage
type: endpoint
last_updated: 2026-11-13
feature: deployment-templates
related:
  - https://docs.corefinity.com/guides/sites/code-and-deployments/deployment-templates.md
  - https://docs.corefinity.com/mcp/tools/corestack_deployments_template_usage_list.md
---
# List the environments a template reaches

Answers the environments of this platform the template reaches, 50 a page, each with what every stage does
(follows the template or holds its own content), and a summary of the counts. Paged by cursor: send
`next_cursor` back as `cursor`; null means the last page.

```http
GET /api/corestack/companies/{company}/deploy-templates/{platform}/usage
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 120 a minute
- Try it in the console: on

## Path parameters

- `company` (integer, required): The id of a company you belong to or manage. Digits only.
- `platform` (string, required): The platform the template is for, such as `magento2`, `laravel` or `wordpress`. The list answers the ones your company can have.

## Query parameters

- `cursor` (integer): The `next_cursor` of the previous answer, a whole number here. Anything else is refused `422` `invalid` on `cursor`.
- `role` (string): Only production environments, or only the others.
- `stage` (string)
- `state` (string): Only the environments in this state.
- `q` (string): A domain or environment name to search for.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/companies/1204/deploy-templates/magento2/usage \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/companies/1204/deploy-templates/magento2/usage');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/companies/1204/deploy-templates/magento2/usage', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/companies/1204/deploy-templates/magento2/usage",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 A page of environments, with the summary.

```json
{
  "data": [
    {
      "binding_id": 2210,
      "changed_since_deploy": [],
      "environment": {
        "name": "Production",
        "slug": "production"
      },
      "last_deployment": null,
      "role": "production",
      "site": {
        "domain": "harbourandfinch.example.com",
        "id": 1042,
        "kind": "corecluster",
        "owner": null
      },
      "site_id": 1042,
      "stages": {
        "build": {
          "level": "corefinity",
          "revision": 2,
          "state": "follows"
        },
        "database": {
          "level": "corefinity",
          "revision": 2,
          "state": "follows"
        },
        "post_deploy": {
          "level": "owner",
          "revision": 2,
          "state": "follows"
        },
        "settings": {
          "level": "corefinity",
          "revision": 2,
          "state": "follows"
        }
      },
      "states": [
        "follows_every_stage"
      ]
    }
  ],
  "next_cursor": null,
  "summary": {
    "changed_since_deploy": 0,
    "environments": 1,
    "follows_every_stage": 1,
    "kept": 0,
    "overrides_every_stage": 0,
    "overrides_some": 0,
    "production": 1,
    "relink_pending": 0,
    "replaced_below": 0
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), or your company requires two-factor authentication and you have not set it up. For routes outside Managed Clusters.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 422 A field or query parameter is wrong, or is one this endpoint does not take (`invalid`, with the `field`).

```json
{
  "code": "invalid",
  "errors": {
    "name": [
      "The name argument is not in the expected format."
    ]
  },
  "field": "name",
  "message": "Some arguments are not valid.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Deployment templates](https://docs.corefinity.com/guides/sites/code-and-deployments/deployment-templates.md)
- MCP tool: [`corestack_deployments_template_usage_list`](https://docs.corefinity.com/mcp/tools/corestack_deployments_template_usage_list.md)
