Customer.io
v1.0.0
OpenAPI 3.1.0

List emails

US region

Client Libraries
Shell Curl

List emails

​

Returns a paginated list of emails and a separate array of folders that the emails belong to.

Query Parameters
  • page
    Type: integer
    min:  
    1

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

  • limit
    Type: integer
    min:  
    1
    max:  
    10000

    Limit the number of results per page.

  • parent_folder_id
    Type: string Format: 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_only
    Type: boolean

    If true, this returns only children of the parent folder.

  • sort_by
    Type: string enum
    values
    • created
    • updated
    • name
  • sort_order
    Type: string enum
    values
    • asc
    • desc
  • created_before
    Type: integer Format: Unix timestamp

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

  • created_after
    Type: integer Format: Unix timestamp

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

  • updated_before
    Type: integer Format: Unix timestamp

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

  • updated_after
    Type: integer Format: Unix timestamp

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

  • is_template
    Type: string enum

    Filter by whether the email is a template

    values
    • true
    • false
    • any
  • has_translations
    Type: string enum

    Filter by whether the email has translations

    values
    • true
    • false
    • any
  • is_linked
    Type: string enum

    Filter by whether the email is linked to a workflow (automation, broadcast, etc).

    values
    • true
    • false
    • any
Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v1/design_studio/emails
curl https://api.customer.io/v1/design_studio/emails

{
  "emails": [
    {
      "created": 1714732800,
      "has_translations": true,
      "id": "sdflkj345",
      "is_linked": true,
      "is_template": true,
      "name": "string",
      "parent_folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "updated": 1714732800
    }
  ],
  "folders": [
    {
      "created": 1714732800,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Product Announcements",
      "parent_folder_id": null,
      "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
    },
    "pagination": {
      "limit": 1,
      "page": 1,
      "total": 1
    }
  }
}

Successful response