Get Script Tag List

Retrieves a paginated list of all script tags in a shop's storefront.

🔒

Requires read_script_tag access scope. More access scope

This Get Script Tag List API endpoint allows developers to retrieve a paginated list of all script tags configured in a Shoplazza store's storefront.

This API is especially useful for:

  1. Auditing all active script tags on the storefront
  2. Reviewing script sources and their implementation scope
  3. Managing client-side integrations and their configurations

Request Parameters

Public Request Parameters

📘

Query Parameters

ParameterTypeRequiredDescriptionExample
cursorstringNoPagination cursor for fetching the next set of results'cursor_123456789'
page_sizeint32NoNumber of script tags to return per page (default pagination size applies if not specified)20
event_typestringNoFilter script tags by their event type (e.g., 'onload', 'dom_ready')'myapp'

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring"200"HTTP status code
messagestring"Success"Operation result message
data.script_tagsobject-The updated script tag object

Script Tag Object

ParameterTypeExampleDescription
idstring"script_tag_123456789"Unique identifier for the script tag
display_scopestring"index"Indicates where the script tag is applied
srcstring"https://shoplazza.com/x.js"URL of the script file
event_typestring"myapp"The tag type, as specified during creation
created_atstring"2025-06-15T10:30:00Z"Timestamp when the script tag was created (ISO 8601 format)
updated_atstring"2025-06-15T11:45:00Z"Timestamp when the script tag was last updated (ISO 8601 format)

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!