CUcustomer
Components

List components

Changed on

Returns a paginated list of components and any folders in the result set.

get/v1/design_studio/components

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/design_studio/components
  • Auth
    HTTP bearer

Query parameters

tagstring

Filter by component tag name. This is the name of the tag inserted into your emails.

pageinteger

The page number of results you want to display. Use with limit.

limitinteger

The maximum number of results per page.

parent_folder_idstring uuid

Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory.

To list only items in the root folder, leave parent_folder_id unset and only set direct_descendants_only to true.

direct_descendants_onlyboolean

When true, the response includes only the immediate children of the parent folder. When false, it includes the parent folder's entire subtree.

sort_by'created' | 'updated' | 'name'
sort_order'asc' | 'desc'
created_beforeinteger

Return records created before this time. Must be a unix timestamp.

created_afterinteger

Return records created after this time. Must be a unix timestamp.

updated_beforeinteger

Return records updated before this time. Must be a unix timestamp.

updated_afterinteger

Return records updated after this time. Must be a unix timestamp.

Response

Successful response

Example response

{
  "components": [
    {
      "id": "e89b-12d3",
      "name": "Custom footer",
      "tag": "custom-footer",
      "parent_folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "created": 1773856017,
      "updated": 1773856019
    }
  ],
  "folders": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Product Announcements",
      "parent_folder_id": null,
      "created": 1714732800,
      "updated": 1714732800
    }
  ],
  "meta": {
    "filters": {
      "parent_folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "direct_descendants_only": true,
      "sort_by": "created",
      "sort_order": "desc",
      "created_before": 1714732800,
      "created_after": null,
      "updated_before": null,
      "updated_after": null
    }
  }
}

Changes

  • 6378ded43e43Revision changes
    • info

      the endpoint scheme security Bearer-Auth was added to the API

    • info

      api tag Components added

    • info

      api tag Design Studio removed

  • b0a0db5fbc21Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status