---
title: "Get a single process template by slug"
method: GET
path: "/platformhub/{gitRef}/processtemplates/{slug}"
tags: ["ProcessTemplates"]
---

# Get a single process template by slug

`GET /platformhub/{gitRef}/processtemplates/{slug}`

## Path parameters

- `gitRef` string, required
- `slug` string, required

## Response `200`

Success

- ProcessTemplateResource
  - `Description` string
  - `GitRef` string
  - `Icon` IconResource
    - `Color` string
    - `Id` string
  - `Id` string
  - `Name` string
  - `Parameters` ProcessTemplateParameterResource[]
    - `DisplaySettings` object
    - `HelpText` string
    - `IsOptional` boolean
    - `Label` string
    - `Name` string
    - `Values` TemplateParameterValueResource[]
      - `Scope` object, required
        - `Project` string[]
        - `Environment` string[]
        - `Machine` string[]
        - `Role` string[]
        - `TargetRole` string[]
        - `Action` string[]
        - `User` string[]
        - `Trigger` string[]
        - `ParentDeployment` string[]
        - `Private` string[]
        - `Channel` string[]
        - `TenantTag` string[]
        - `Tenant` string[]
        - `ProcessOwner` string[]
        - `ProjectTemplate` string[]
        - `TemplatedProject` string[]
        - `ProcessTemplateStep` string[]
        - `EnvironmentParameter` string[]
        - `TargetTagParameter` string[]
        - `TenantTagParameter` string[]
      - `Value` PropertyValueResource, required
        - `IsSensitive` boolean
        - `SensitiveValue` SensitiveValue
          - `HasValue` boolean
          - `Hint` string
          - `NewValue` string
        - `Value` string
  - `Slug` string
  - `Steps` DeploymentStepResource[]
    - `Actions` DeploymentActionResource[]
      - `ActionType` string
      - `AvailableStepPackageVersions` string[]
      - `CanBeUsedForProjectVersioning` boolean
      - `Channels` string[]
      - `ChannelsVariable` string
      - `CommunityActionTemplateSnapshot` CommunityActionTemplateSnapshotResource
        - `Id` string
        - `Parameters` ActionTemplateParameterResource[]
          - `DefaultValue` PropertyValueResource
            - `IsSensitive` boolean
            - `SensitiveValue` SensitiveValue
              - …
            - `Value` string
          - `DisplaySettings` object
          - `HelpText` string
          - `Id` string
          - `Label` string
          - `Name` string
        - `Version` integer
      - `Condition` 'Success' | 'Variable'
      - `Container` DeploymentActionContainerResource
        - `Dockerfile` string
        - `FeedId` string
        - `GitUrl` string
        - `Image` string
      - `Environments` string[]
      - `EnvironmentsVariable` string
      - `ExcludedEnvironments` string[]
      - `ExcludedEnvironmentsVariable` string
      - `GitDependencies` GitDependencyResource[]
        - `DefaultBranch` string, required
        - `FilePathFilters` string[]
        - `GitCredentialId` string
        - `GitCredentialType` string, required
        - `GitHubConnectionId` string
        - `Name` string, required
        - `RepositoryUri` string, required
        - `StepPackageInputsReferenceId` string
      - `Id` string
      - `Inputs` StepPackageInputsResource
        - `Value` unknown
      - `IsDisabled` boolean
      - `IsRequired` boolean
      - `LastModifiedBy` string
      - `LastModifiedOn` string, date-time
      - `LastSavedStepPackageVersion` string
      - `Links` object
      - `Name` string
      - `Notes` string
      - `Packages` PackageReferenceResource[]
        - `AcquisitionLocation` string
        - `FeedId` string
        - `Id` string
        - `Name` string
        - `PackageId` string
        - `Properties` object
        - `StepPackageInputsReferenceId` string
        - `Version` string
      - `Properties` object
      - `Slug` string
      - `StepPackageVersion` string
      - `TenantTags` string[]
      - `TenantTagsVariable` string
      - `WorkerPoolId` string
      - `WorkerPoolVariable` string
    - `Condition` 'Success' | 'Failure' | 'Always' | 'Variable'
    - `Id` string
    - `Name` string, required
    - `PackageRequirement` 'LetOctopusDecide' | 'BeforePackageAcquisition' | 'AfterPackageAcquisition'
    - `Properties` object
    - `Slug` string
    - `StartTrigger` 'StartAfterPrevious' | 'StartWithPrevious'
    - `Type` string

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)