List Available Content Blocks

get

/content_blocks/list

This endpoint will list you existing Content Blocks information.

See me in Postman

Request Parameters

Parameter Required Data Type Description
modified_after Optional String in ISO-8601 format Retrieve only content blocks updated at or after the given time.
modified_before Optional String in ISO-8601 format Retrieve only content blocks updated at or before the given time.
limit Optional Positive Number Maximum number of content blocks to retrieve. Default to 100 if not provided, with a maximum acceptable value of 1000.
offset Optional Positive Number Number of content blocks to skip before returning rest of the templates that fit the search criteria.

Example Request

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/content_blocks/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=100&offset=1' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

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. - The limit parameter must be an integer (positive number) greater than 0.

  • Content Block number limit must be greater than 0. - The limit parameter must be an integer (positive number) greater than 0.

  • Content Block number limit exceeds maximum of 1000. - The limit parameter must be an integer (positive number) greater than 0.

  • Offset is invalid. - The offset parameter must be an integer (positive number) greater than 0.

  • Offset must be greater than 0. - The offset parameter must be an integer (positive number) greater than 0.

  Edit this page on GitHub
WAS THIS PAGE HELPFUL?
New Stuff!