---
title: "Get a company's deployment template"
url: https://docs.corefinity.com/api/reference/deployments/get-deploy-template
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_get.md
---
# Get a company's deployment template

Answers the template for one platform: what the company has set for each stage of the production and UAT
configurations, what each stage inherits and what is in effect, the build presets on offer, and whether you
may edit it.

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

- 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

- `version` (integer): A kept revision to read instead of the current one.
- `compare_to` (string or integer): `current`, `previous` or a revision number. Adds `compare` to the answer, with the before and after of each changed stage.
- `upstream` (string): One upstream to answer, as `upstreams[].upstream` names it (`none`, or `agency:` and the agency's id).

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/companies/1204/deploy-templates/magento2 \
  -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');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/companies/1204/deploy-templates/magento2', {
  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",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The template.

```json
{
  "can": {
    "edit": true,
    "edit_reason": null
  },
  "chain_note": null,
  "company": {
    "id": 1180,
    "name": "Northwind Digital"
  },
  "configs": {
    "production": {
      "build": {
        "mode": "inherit"
      },
      "database": {
        "mode": "inherit"
      },
      "post_deploy": {
        "mode": "replace",
        "value": {
          "lines": [
            "php bin/magento cache:flush"
          ]
        }
      },
      "settings": {
        "mode": "inherit"
      }
    },
    "uat": {
      "build": {
        "mode": "inherit"
      },
      "database": {
        "mode": "inherit"
      },
      "post_deploy": {
        "mode": "inherit"
      },
      "settings": {
        "mode": "inherit"
      }
    }
  },
  "locked": null,
  "platform": "magento2",
  "presets": {
    "offered": [
      {
        "key": "magento2_standard",
        "kind": "platform",
        "label": "Magento 2 standard",
        "node_floor": null,
        "node_floor_when": null
      },
      {
        "key": "none",
        "kind": "platform",
        "label": "No build",
        "node_floor": null,
        "node_floor_when": null
      }
    ]
  },
  "revision": 2,
  "template_id": 12,
  "upstreams": [
    {
      "agency": null,
      "chain": [
        {
          "company": null,
          "level": "corefinity",
          "revision": 2,
          "template_id": null
        },
        {
          "company": {
            "id": 1180,
            "name": "Northwind Digital"
          },
          "level": "owner",
          "revision": 2,
          "template_id": 12
        }
      ],
      "environments": {
        "production": 1,
        "total": 1
      },
      "stages": {
        "production": {
          "post_deploy": {
            "differs_from_none": false,
            "effective": {
              "lines": [
                "php bin/magento cache:flush"
              ]
            },
            "inherited": {
              "company": null,
              "level": "corefinity",
              "revision": 2,
              "value": {
                "lines": []
              }
            }
          }
        }
      },
      "upstream": "none"
    }
  ]
}
```

### 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 company does not exist or is not one you manage, the platform has no template, or `version` or `compare_to` names a revision the template does not keep (`previous` when there is none before it): all answer `Not found.` with no reason. Or deployment templates are 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_get`](https://docs.corefinity.com/mcp/tools/corestack_deployments_template_get.md)
