Skip to main content
GET
/
api
/
develop
/
v1
/
customer-project-templates
/
{id}
Get customer project template by id
curl --request GET \
  --url https://api.example.com/api/develop/v1/customer-project-templates/{id} \
  --header 'X-Domino-Api-Key: <api-key>'
{
  "access": {
    "collaborators": [
      {
        "id": "<string>",
        "role": "template_user"
      }
    ]
  },
  "categories": [
    "<string>"
  ],
  "created": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "isCompanyOfficial": true,
  "name": "<string>",
  "owner": {
    "name": "<string>",
    "link": "<string>"
  },
  "updated": "2023-11-07T05:31:56Z",
  "definition": {
    "backingProject": {
      "id": "<string>",
      "name": "<string>",
      "owner": {
        "username": "<string>"
      }
    },
    "settings": {
      "defaultEnvironmentRevision": {
        "environment": {
          "id": "<string>",
          "name": "<string>"
        },
        "id": "<string>"
      },
      "defaultHardwareTier": {
        "id": "<string>",
        "name": "<string>"
      },
      "computeClusterEnvironmentRevision": {
        "environment": {
          "id": "<string>",
          "name": "<string>"
        },
        "id": "<string>"
      }
    }
  },
  "isArchived": true,
  "sourceProject": {
    "id": "<string>",
    "included": [],
    "name": "<string>",
    "owner": {
      "username": "<string>"
    }
  },
  "base64Logo": "<string>",
  "description": "<string>",
  "license": "<string>",
  "recommended": true,
  "revisionId": "<string>",
  "taxonomyTags": [
    {
      "id": "<string>",
      "label": "<string>",
      "namespaceId": "<string>",
      "description": "<string>",
      "fullPath": [
        "<string>"
      ],
      "namespaceLabel": "<string>"
    }
  ]
}

Authorizations

X-Domino-Api-Key
string
header
required

Path Parameters

id
string
required

The id of the project template to return.

Pattern: ^[0-9a-f]{24}$

Query Parameters

includeArchived
boolean
default:false

If the template is archived and this parameter is set to true, the template will be returned instead of a 404.

Response

Success

access
object
required
categories
string[]
required
created
string<date-time>
required
id
string
required
isCompanyOfficial
boolean
required

Whether or not this template is marked as official

name
string
required
owner
object
required
templateType
enum<string>
required
Available options:
customer,
ecosystem
updated
string<date-time>
required
definition
object
required
isArchived
boolean
required
sourceProject
object
required
description
string
license
string
revisionId
string
taxonomyTags
object[]

Taxonomy tags associated with this template.