List Available Content Blocks
GET https://{{instance_url}}/content_blocks/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=100&offset=1
This endpoint will list existing Content Block information.
Successful Response Properties
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"count": "integer",
"content_blocks": [
{
"content_block_id": "string",
"name": "string",
"content_type": "html or text",
"liquid_tag": "string",
"inclusion_count" : "integer",
"created_at": "time-in-iso",
"last_edited": "time-in-iso",
"tags" : "array of strings"
}
]
}
Possible Errors
Modified after time is invalid.
The date you have provided is not a valid or parsable date. Please reformat this value as a string in ISO 8601 format (yyyy-mm-ddThh:mm:ss.ffffff
).Modified before time is invalid.
The date you have provided is not a valid or parsable date. Please reformat this value as a string in ISO 8601 format (yyyy-mm-ddThh:mm:ss.ffffff
).Modified after time must be earlier than or the same as modified before time.
Content Block number limit is invalid.
Thelimit
parameter must be an integer (positive number) greater than 0.Content Block number limit must be greater than 0.
Thelimit
parameter must be an integer (positive number) greater than 0.Content Block number limit exceeds maximum of 1000.
Thelimit
parameter must be an integer (positive number) greater than 0.Offset is invalid.
Theoffset
parameter must be an integer (positive number) greater than 0.Offset must be greater than 0.
Theoffset
parameter must be an integer (positive number) greater than 0.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
modified_after | string | (Optional) String in ISO 8601 |
Retrieve only content blocks updated at or after the given time. |
| modified_before
| string | | (Optional) String in ISO 8601
Retrieve only content blocks updated at or before the given time. |
| limit
| number | | (Optional) Positive Number
Maximum number of content blocks to retrieve, default to 100 if not provided, maximum acceptable value is 1000. |
| offset
| number | | (Optional) Positive Number
Number of content blocks to skip before returning rest of the templates that fit the search criteria. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |