RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Snippets API

Create, Retrieve, Update and Delete Snippets via the public API endpoint using "where" filtering.

GET Snippets List

Retrieves a list of Snippets as a JSON response based on your provided query parameters.

/api/v2/admin/snippets

Parameters

Parameter
Values
Required
Where
{<where query>}
Order_By
<propertyAlias>
Semantic_Query
<string>
Min_Score
<double>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": 0,
      "Name": "string",
      "Alias": "string",
      "Content": "string",
      "FtpPath": "string",
      "LiquidAlias": "string",
      "Enabled": true,
      "CodeEditor": true
    }
  ],
  "TotalItemsCount": 0
}

POST Snippet Create

Creates a new Snippet based on the provided data.

/api/v2/admin/snippets

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "Content": "string",
  "Enabled": true,
  "CodeEditor": true
}

{
  "Id": 0,
  "Name": "string",
  "Alias": "string",
  "Content": "string",
  "FtpPath": "string",
  "LiquidAlias": "string",
  "Enabled": true,
  "CodeEditor": true
}

GET Snippet Item

Retrieves a single Snippet based on the ID passed in the endpoint URL.

/api/v2/admin/snippets/{id}

Data / Response:

N/A

{
  "Id": 0,
  "Name": "string",
  "Alias": "string",
  "Content": "string",
  "FtpPath": "string",
  "LiquidAlias": "string",
  "Enabled": true,
  "CodeEditor": true
}

PUT Snippet Update

Updates a single Snippet based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/snippets/{id}

Data / Response:

{
  "Id": 0,
  "Name": "string",
  "Alias": "string",
  "Content": "string",
  "Enabled": true,
  "CodeEditor": true
}

{
  "Id": 0,
  "Name": "string",
  "Alias": "string",
  "Content": "string",
  "FtpPath": "string",
  "LiquidAlias": "string",
  "Enabled": true,
  "CodeEditor": true
}

DELETE Snippet Delete

Deletes a single Snippet based on the ID passed in the endpoint URL.

/api/v2/admin/snippets/{id}

Data / Response:

N/A

Status 204