{
  "opencollection": "1.0.0",
  "info": {
    "name": "SpotDraft V1 Contract APIs V2.1 Templates API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "V2.1 Templates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Template List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.eu.spotdraft.com/api/v2.1/public/templates/",
            "params": [
              {
                "name": "cp_types",
                "value": "",
                "type": "query",
                "description": "The type of Counterparty that can be added to contracts created from this template.\nMust be either `Organisation` or `Individual`.\nThis value will be used to filter the list of templates returned by the API.\nThe template will be having one or more CP that match cp_types."
              },
              {
                "name": "cp_types_all",
                "value": "",
                "type": "query",
                "description": "When a template has multiple counterparties, whether all counterparties should match the CP type given in cp_types.\nFalse by default"
              },
              {
                "name": "exclude_multi_party",
                "value": "",
                "type": "query",
                "description": "Whether templates that support multiple counterparties should be excluded."
              },
              {
                "name": "include_archived",
                "value": "",
                "type": "query",
                "description": "Whether archived templates should be included in the results."
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "The tags (if any) to filter the templates by.\n\nMultiple tags can be specified by specifying the query param multiple times. Only templates where the Template tags are a subset of the tags passed will be returned."
              },
              {
                "name": "tags_all",
                "value": "",
                "type": "query",
                "description": "The tags (if any) to filter the templates by.\n\nMultiple tags can be specified by specifying the query param multiple times. Only templates where the tags passed are a subset of the Template tags will be returned."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "client-id",
              "value": "{{client-id}}",
              "placement": "header"
            }
          },
          "docs": "\nLists published templates available to the workspace tied to the API credentials.\nUse query parameters to filter by tags, counterparty type, archive state, and multipart support.\n"
        },
        {
          "info": {
            "name": "Get Template Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.eu.spotdraft.com/api/v2.1/public/templates/:template_id/",
            "params": [
              {
                "name": "template_id",
                "value": "",
                "type": "path",
                "description": "The ID of the template."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "client-id",
              "value": "{{client-id}}",
              "placement": "header"
            }
          },
          "docs": "\nReturns the template details available to the current workspace, including workspace-specific access data.\nUse this before update calls when you need the current configuration state.\n"
        },
        {
          "info": {
            "name": "Update Template Data",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.eu.spotdraft.com/api/v2.1/public/templates/:template_id/",
            "params": [
              {
                "name": "template_id",
                "value": "",
                "type": "path",
                "description": "The ID of the template."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "client-id",
              "value": "{{client-id}}",
              "placement": "header"
            }
          },
          "docs": "\nUpdates the workspace-specific data stored against a template.\nThis is the version to use for self-serve and DraftMate-enabled template workflows.\n"
        },
        {
          "info": {
            "name": "Get Template Metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.eu.spotdraft.com/api/v2.1/public/templates/:template_id/metadata",
            "params": [
              {
                "name": "template_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "client-id",
              "value": "{{client-id}}",
              "placement": "header"
            }
          },
          "docs": "\nGets the list of fields required to create a contract with a given template.\n\nThe list of attributes returned define how a `contract_data` payload is to be\nconstructed for the [V2.1 Create Contract](#tag/v21-contract-apis/POST/api/v2.1/public/contracts/) request.\nV2.1 must be used for templates created using the DraftMate Add-on.\n"
        }
      ]
    }
  ],
  "bundled": true
}