{
  "service": "contentstack_content_delivery",
  "displayName": "Contentstack Content Delivery",
  "categories": [
    "Data",
    "Productivity"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "Stack API Key",
      "placeholder": "CONTENTSTACK_STACK_API_KEY",
      "description": "Contentstack stack API key sent with the api_key header. Find it with the Delivery Token in your stack under Settings > Tokens > Delivery Tokens: https://www.contentstack.com/docs/developers/create-tokens/about-delivery-tokens",
      "extraFields": [
        {
          "key": "deliveryToken",
          "label": "Delivery Token",
          "inputType": "password",
          "required": true,
          "secret": true,
          "placeholder": "CONTENTSTACK_DELIVERY_TOKEN",
          "description": "Contentstack Delivery Token sent with the access_token header for published content. Create or view it under Settings > Tokens > Delivery Tokens: https://www.contentstack.com/docs/developers/create-tokens/create-a-delivery-token"
        },
        {
          "key": "branch",
          "label": "Branch UID",
          "inputType": "text",
          "required": false,
          "secret": false,
          "placeholder": "main",
          "description": "Optional Contentstack branch UID sent with the branch header when your stack uses branches."
        }
      ]
    }
  ],
  "homepageUrl": "https://www.contentstack.com/",
  "actions": [
    {
      "id": "contentstack_content_delivery.get_content_type",
      "service": "contentstack_content_delivery",
      "name": "get_content_type",
      "description": "Retrieve one Contentstack content type schema by UID.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "contentTypeUid": {
            "type": "string",
            "minLength": 1,
            "description": "The Contentstack UID identifying the requested resource."
          },
          "branch": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack branch UID passed with the branch request header."
          },
          "includeBranch": {
            "type": "boolean",
            "description": "Whether Contentstack should include the _branch field."
          },
          "includeGlobalFieldSchema": {
            "type": "boolean",
            "description": "Whether Contentstack should include global field schemas in content type responses."
          }
        },
        "additionalProperties": false,
        "required": [
          "contentTypeUid"
        ],
        "description": "Input parameters for retrieving one Contentstack content type."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "contentType": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The raw Contentstack JSON object."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The raw Contentstack JSON object."
          }
        },
        "additionalProperties": false,
        "description": "Contentstack content type response."
      }
    },
    {
      "id": "contentstack_content_delivery.get_entry",
      "service": "contentstack_content_delivery",
      "name": "get_entry",
      "description": "Retrieve one published Contentstack entry for a content type.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "contentTypeUid": {
            "type": "string",
            "minLength": 1,
            "description": "The Contentstack UID identifying the requested resource."
          },
          "entryUid": {
            "type": "string",
            "minLength": 1,
            "description": "The Contentstack UID identifying the requested resource."
          },
          "environment": {
            "type": "string",
            "minLength": 1,
            "description": "The Contentstack publishing environment to read published content from."
          },
          "branch": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack branch UID passed with the branch request header."
          },
          "locale": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack locale code for localized content."
          },
          "query": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A Contentstack query object serialized into the query URL parameter."
          },
          "includeMetadata": {
            "type": "boolean",
            "description": "Whether Contentstack should include extension metadata."
          },
          "includePublishDetails": {
            "type": "boolean",
            "description": "Whether Contentstack should include publish details in entry responses."
          },
          "includeFallback": {
            "type": "boolean",
            "description": "Whether Contentstack should return fallback locale content when localized content is missing."
          },
          "includeBranch": {
            "type": "boolean",
            "description": "Whether Contentstack should include the _branch field."
          },
          "includeFields": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "A Contentstack field UID."
            },
            "description": "Contentstack field UIDs to include or exclude in the response.",
            "minItems": 1
          },
          "excludeFields": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "A Contentstack field UID."
            },
            "description": "Contentstack field UIDs to include or exclude in the response.",
            "minItems": 1
          }
        },
        "additionalProperties": false,
        "required": [
          "contentTypeUid",
          "entryUid",
          "environment"
        ],
        "description": "Input parameters for retrieving one Contentstack entry."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "entry": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The raw Contentstack JSON object."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The raw Contentstack JSON object."
          }
        },
        "additionalProperties": false,
        "description": "Contentstack entry response."
      }
    },
    {
      "id": "contentstack_content_delivery.list_assets",
      "service": "contentstack_content_delivery",
      "name": "list_assets",
      "description": "List published Contentstack assets in a stack.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "environment": {
            "type": "string",
            "minLength": 1,
            "description": "The Contentstack publishing environment to read published content from."
          },
          "branch": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack branch UID passed with the branch request header."
          },
          "locale": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack locale code for localized content."
          },
          "query": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A Contentstack query object serialized into the query URL parameter."
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The maximum number of items to return. Contentstack returns at most 100 items."
          },
          "skip": {
            "type": "integer",
            "minimum": 0,
            "description": "The number of items to skip for pagination."
          },
          "includeCount": {
            "type": "boolean",
            "description": "Whether Contentstack should include the total item count."
          },
          "includeMetadata": {
            "type": "boolean",
            "description": "Whether Contentstack should include extension metadata."
          },
          "includeFallback": {
            "type": "boolean",
            "description": "Whether Contentstack should return fallback locale content when localized content is missing."
          },
          "includeBranch": {
            "type": "boolean",
            "description": "Whether Contentstack should include the _branch field."
          },
          "includeDimension": {
            "type": "boolean",
            "description": "Whether Contentstack should include image dimension details in asset responses."
          },
          "asc": {
            "type": "string",
            "minLength": 1,
            "description": "A Contentstack field UID used to sort the returned items."
          },
          "desc": {
            "type": "string",
            "minLength": 1,
            "description": "A Contentstack field UID used to sort the returned items."
          }
        },
        "additionalProperties": false,
        "required": [
          "environment"
        ],
        "description": "Input parameters for listing Contentstack assets."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "assets": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "The raw Contentstack JSON object."
            },
            "description": "Contentstack asset objects."
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total asset count when included by Contentstack."
              },
              {
                "type": "null"
              }
            ]
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The raw Contentstack JSON object."
          }
        },
        "additionalProperties": false,
        "description": "Contentstack assets response."
      }
    },
    {
      "id": "contentstack_content_delivery.list_content_types",
      "service": "contentstack_content_delivery",
      "name": "list_content_types",
      "description": "List content types available in a Contentstack stack.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "branch": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack branch UID passed with the branch request header."
          },
          "query": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A Contentstack query object serialized into the query URL parameter."
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The maximum number of items to return. Contentstack returns at most 100 items."
          },
          "skip": {
            "type": "integer",
            "minimum": 0,
            "description": "The number of items to skip for pagination."
          },
          "includeCount": {
            "type": "boolean",
            "description": "Whether Contentstack should include the total item count."
          },
          "includeBranch": {
            "type": "boolean",
            "description": "Whether Contentstack should include the _branch field."
          },
          "includeGlobalFieldSchema": {
            "type": "boolean",
            "description": "Whether Contentstack should include global field schemas in content type responses."
          }
        },
        "additionalProperties": false,
        "description": "Input parameters for listing Contentstack content types."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "contentTypes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "The raw Contentstack JSON object."
            },
            "description": "Contentstack content type objects."
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total content type count when included by Contentstack."
              },
              {
                "type": "null"
              }
            ]
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The raw Contentstack JSON object."
          }
        },
        "additionalProperties": false,
        "description": "Contentstack content types response."
      }
    },
    {
      "id": "contentstack_content_delivery.list_entries",
      "service": "contentstack_content_delivery",
      "name": "list_entries",
      "description": "List published Contentstack entries for a content type.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "contentTypeUid": {
            "type": "string",
            "minLength": 1,
            "description": "The Contentstack UID identifying the requested resource."
          },
          "environment": {
            "type": "string",
            "minLength": 1,
            "description": "The Contentstack publishing environment to read published content from."
          },
          "branch": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack branch UID passed with the branch request header."
          },
          "locale": {
            "type": "string",
            "minLength": 1,
            "description": "The optional Contentstack locale code for localized content."
          },
          "query": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A Contentstack query object serialized into the query URL parameter."
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 100,
            "description": "The maximum number of items to return. Contentstack returns at most 100 items."
          },
          "skip": {
            "type": "integer",
            "minimum": 0,
            "description": "The number of items to skip for pagination."
          },
          "includeCount": {
            "type": "boolean",
            "description": "Whether Contentstack should include the total item count."
          },
          "includeMetadata": {
            "type": "boolean",
            "description": "Whether Contentstack should include extension metadata."
          },
          "includePublishDetails": {
            "type": "boolean",
            "description": "Whether Contentstack should include publish details in entry responses."
          },
          "includeFallback": {
            "type": "boolean",
            "description": "Whether Contentstack should return fallback locale content when localized content is missing."
          },
          "includeBranch": {
            "type": "boolean",
            "description": "Whether Contentstack should include the _branch field."
          },
          "includeFields": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "A Contentstack field UID."
            },
            "description": "Contentstack field UIDs to include or exclude in the response.",
            "minItems": 1
          },
          "excludeFields": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "description": "A Contentstack field UID."
            },
            "description": "Contentstack field UIDs to include or exclude in the response.",
            "minItems": 1
          },
          "asc": {
            "type": "string",
            "minLength": 1,
            "description": "A Contentstack field UID used to sort the returned items."
          },
          "desc": {
            "type": "string",
            "minLength": 1,
            "description": "A Contentstack field UID used to sort the returned items."
          }
        },
        "additionalProperties": false,
        "required": [
          "contentTypeUid",
          "environment"
        ],
        "description": "Input parameters for listing Contentstack entries of one content type."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "entries": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": true,
              "description": "The raw Contentstack JSON object."
            },
            "description": "Contentstack entry objects."
          },
          "count": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total entry count when included by Contentstack."
              },
              {
                "type": "null"
              }
            ]
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The raw Contentstack JSON object."
          }
        },
        "additionalProperties": false,
        "description": "Contentstack entries response."
      }
    }
  ]
}