Content API Responses

Types of responses

The content API supports multiple levels of detail in its responses: basic, full and dynamic.

Basic Detail

Method

GET https://example.kapost.com/api/v1/content?detail=basic&...

GET https://example.kapost.com/api/v1/content/<content_id>?detail=basic&...

Example Response

Example response from querying https://example.kapost.com/api/v1/content?detail=basic&per_page=1&page=3

{
  "response": [
    {
      "id": "5ced766681f99f0032000006",
      "slug": "sample-content-1",
      "title":"Sample Content 1",
      "creator_id": "4da754c5514e390ae100008d",
      "assignee_id":"4da754c5514e390ae100008d",
      "campaign_ids": ["5ec998a3301f002ff1000029"],
      "preferred_title": "sample content 1",
      "next_task": "Submit Plan",
      "state": "production",
      "archived": false,
      "updated_at": "2019-05-30T12:27:21Z",
      "factory_url": "https://example.kapost.com/posts/sample-content-1",
      "content_type": {
        "background_color":"rgb(204, 201, 0)",
        "body_type": "event",
        "display_name": "Event",
        "field_name": "event",
        "icon": "words",
        "icon_css_class": "words",
        "id": "5500994dc999d7822d00075c",
        "newsroom_id": "550098c9c999d7822d00001b",
        "updated_at": "2019-02-15T15:57:40Z"
      },
      "progress_stage": "in_progress",
      "published_date": null,
      "categories": ["Conventions"]
    },
  ],
  "count": 1,
  "pagination": {
    "previous": 2,
    "next": 4,
    "current": 3,
    "per_page": 1,
    "count": 986,
    "pages": 986
  }
}

Properties

Field Name Field Type Default Value Example Value Description
archived boolean false true Archival state of the content. Archived content is filtered from certain pages and API interactions.
assignee_id string null "5ce4238567e6e238d0000001" ID of user assigned to content.
campaign_ids array [] ["5ce4238567e6e238d0000002"] Array of initiative IDs.
content_type string "5ce4238567e6e238d0000003" Content type ID.
creator_id string null "5ce4238567e6e238d0000004" ID of user who created content.
factory_url string "https://kapost.com/posts/example-content-1" Canonical content URL.
id string "5ce4238567e6e238d0000005" Content ID.
next_task string "Completed" "publish content to blog" Description of next task. Value is "Completed" if all tasks are completed.
preferred_title string "(no title)" "Sample content title" Content title with default value.
progress_stage string "planned" "in_progress" Current content stage. Value is one of: "planned", "in_progress", "complete".
published_date string null "2019-05-17T16:07:30Z" Datetime when content was most recently published.
slug string "sample-content-slug" URL-safe string generated from content title. Unique across all content.
state string "production" "production" Description of current content state. Value is one of: "production", "promotion", "completed"
title string null "Sample content title" Content title.
updated_at string "2019-05-17T16:07:30Z" Datetime content was last updated by a user.

Full Detail

Provides more fields in response than basic detail, but may be more expensive to query.

Method

GET https://example.kapost.com/api/v1/content?detail=full&...

GET https://example.kapost.com/api/v1/content/<content_id>?detail=full&...

Example Response

Example response from querying https://example.kapost.com/api/v1/content?detail=full&per_page=1&page=4

{
  "response": [
    {
      "id": "5ced766681f99f0032000006",
      "slug": "sample-content",
      "title": "Sample Content",
      "creator_id": "4da754c5514e390ae100008d",
      "assignee_id": "4da754c5514e390ae100008d",
      "campaign_ids": ["5cf0034f67e6e22f9a000000"],
      "preferred_title": "sample content",
      "next_task": "Submit Plan",
      "state": "production",
      "archived": false,
      "updated_at": "2019-05-30T12:27:21Z",
      "factory_url": "https://example.kapost.com/posts/sample-content",
      "content_type": {
        "background_color": "rgb(204, 201, 0)",
        "body_type": "html",
        "display_name": "Blog",
        "field_name": "blog",
        "icon": "words",
        "icon_css_class": "words",
        "id": "5500994dc999d7822d00075c",
        "newsroom_id": "550098c9c999d7822d00001b",
        "updated_at": "2019-02-15T15:57:40Z"
      },
      "progress_stage": "in_progress",
      "published_date": null,
      "content": "<p>Here is some sample content!</p>",
      "tags": ["Q1", "Marketing"],
      "custom_fields": [
        {
          "id": "4e6e3603abdd77000100001e",
          "field_type": "text",
          "display_label": "Text custom field",
          "name": "moon moon",
          "default_value": "",
          "created_at": "2015-03-11T19:34:34Z",
          "select_value_ids": {},
          "archived_value_ids": [],
          "options": {
            "editor_or_admin_only": false,
            "required_field": false,
            "html": false,
            "multiline": false,
            "show_character_count": false,
            "api_only": false
          },
          "newsroom_id": "550098c9c999d7822d00001b",
          "visible_in_previews": true,
          "visible_in_insights": false,
          "instructions": null,
          "value": null
        },
        {
          "id": "4e7a5f1d6745770001000025",
          "field_type": "image",
          "display_label": "Preview Image",
          "name": "preview_image",
          "created_at": "2015-03-11T19:34:34Z",
          "select_value_ids": {},
          "archived_value_ids": [],
          "options": {
            "editor_or_admin_only": false,
            "required_field": false
          },
          "newsroom_id": "550098c9c999d7822d00001b",
          "visible_in_previews": true,
          "visible_in_insights": false,
          "instructions": null,
          "value": null
        },
        {
          "id": "5674795e29dc73bb430002fe",
          "field_type": "multiselect",
          "display_label": "Financial Year",
          "name": "multiselect",
          "created_at": "2015-12-18T21:23:42Z",
          "select_values": [
            "2016",
            "2017",
            "2018",
            "2019",
            "2020"
          ],
          "select_value_ids": {
            "588ba98920e6a0002600018b": "2016",
            "588ba98920e6a0002600018c": "2017",
            "588ba98920e6a0002600018d": "2018",
            "588ba98920e6a0002600018e": "2019",
            "588ba98920e6a0002600018f": "2020"
          },
          "archived_value_ids": [],
          "formatted_select_values": [
            {
              "id": "588ba98920e6a0002600018b",
              "display": "2016",
              "value": "16",
              "archived": false
            },
            {
              "id": "588ba98920e6a0002600018c",
              "display": "2017",
              "value": "2017",
              "archived": false
            },
            {
              "id": "588ba98920e6a0002600018d",
              "display": "2018",
              "value": "2018",
              "archived": false
            },
            {
              "id": "588ba98920e6a0002600018e",
              "display": "2019",
              "value": "2019",
              "archived": false
            },
            {
              "id": "588ba98920e6a0002600018f",
              "display": "2020",
              "value": "2020",
              "archived": false
            }
          ],
          "options": {
            "editor_or_admin_only": false,
            "required_field": false,
            "publish_as_array": false,
            "publish_as_hash": false,
            "api_only": false
          },
          "newsroom_id": "550098c9c999d7822d00001b",
          "visible_in_previews": true,
          "visible_in_insights": false,
          "instructions": "Please select the financial years in which this content is intended to be used.",
          "value": null
        },
        {
          "id": "59b2ee6deb4057000900016b",
          "field_type": "select",
          "display_label": "License",
          "name": "license",
          "created_at": "2017-09-08T19:24:29Z",
          "select_values": [
            "Limited",
            "Open Source",
            "Private"
          ],
          "select_value_ids": {
            "59b2ee6deb40570009000168": "Limited",
            "59b2ee6deb40570009000169": "Open Source",
            "59b2ee6deb4057000900016a": "Private"
          },
          "archived_value_ids": [],
          "formatted_select_values": [
            {
              "id": "59b2ee6deb40570009000168",
              "display": "Limited",
              "value": "Limited",
              "archived": false
            },
            {
              "id": "59b2ee6deb40570009000169",
              "display": "Open Source",
              "value": "Open Source",
              "archived": false
            },
            {
              "id": "59b2ee6deb4057000900016a",
              "display": "Private",
              "value": "Private",
              "archived": false
            }
          ],
          "options": {
            "editor_or_admin_only": false,
            "required_field": true,
            "publish_as_array": false,
            "publish_as_hash": false,
            "api_only": false
          },
          "newsroom_id": "550098c9c999d7822d00001b",
          "visible_in_previews": true,
          "visible_in_insights": false,
          "instructions": null,
          "value": null
        },
        {
          "id": "5b33e8c50b4c130027000013",
          "field_type": "date",
          "display_label": "Go Live Date",
          "name": "go_live_date",
          "created_at": "2018-06-27T19:43:01Z",
          "select_value_ids": null,
          "archived_value_ids": [],
          "options": {
            "editor_or_admin_only": false,
            "required_field": false,
            "api_only": false
          },
          "newsroom_id": "550098c9c999d7822d00001b",
          "visible_in_previews": true,
          "visible_in_insights": false,
          "instructions": "date",
          "value": null
        }
      ],
      "published_url": "",
      "library_tracking_url": null,
      "last_updated_by": {
        "id": "4da754c5514e390ae100008d",
        "email": "example@kapost.com",
        "name": "Sample User",
        "avatar_feed_url": "https://d1g3sjr3z2dvsh.cloudfront.net/uploads/user/avatar/4da754c5514e390ae100008d/feed_hqdefault.jpg",
        "avatar_thumbnail_url": "https://d1g3sjr3z2dvsh.cloudfront.net/uploads/user/avatar/4da754c5514e390ae100008d/thumbnail_hqdefault.jpg",
        "avatar_profile_large_url": "https://d1g3sjr3z2dvsh.cloudfront.net/uploads/user/avatar/4da754c5514e390ae100008d/profilelarge_hqdefault.jpg",
        "avatar_profile_url": "https://d1g3sjr3z2dvsh.cloudfront.net/uploads/user/avatar/4da754c5514e390ae100008d/profile_hqdefault.jpg",
        "slug": "sample-user",
        "created_at": "2011-04-14T20:10:45Z",
        "updated_at": "2019-05-30T16:01:05Z",
        "bio": "Sample bio information",
        "short_bio": "Sample bio",
        "visitor": false,
        "tz": "America/Denver",
        "follow_discussion_allowed": true,
        "superadmin": false,
        "tours_seen": [
          "annotations_mode_button",
          "board_viewer",
          "matrix_edit",
          "saved_views_intro",
          "saved_views_adv",
          "canvas_plans_manage_access",
          "board_curator",
          "timeline_edit"
        ],
        "phone": "555-303-3030"
      },
      "attachments": [],
      "media_url": null,
      "categories": []
    }
  ],
  "count": 1,
  "pagination": {
    "previous": 3,
    "next": 5,
    "current": 4,
    "per_page": 1,
    "count": 986,
    "pages": 986
  }
}

Properties

Field Name Field Type Default Value Example Value Description
last_updated_by_details object null {"id": "51a89b645ddcc2d94a000005", "email": "", "name": "", "name_sort": "", "avatar_feed_url": "", "avatar_thumbnail_url": "", "avatar_profile_large_url": "", "avatar_profile_url": "", "slug": "", "created_at": "2013-05-31T12:45:24Z", "updated_at": "2023-08-09T09:52:15Z", "bio": "", "short_bio": "", "visitor": false, "tz": "Europe/Helsinki", "follow_discussion_allowed": false, "superadmin": false, "tours_seen": ["annotations_mode_button", "annotations_mode", "matrix_edit", "saved_views_intro", "canvas_plans_manage_access","board_curator", "board_viewer"], "phone": "", "removed": false, "role": "admin", "group_ids": []} attributes of the user who last updated the content.
owner_details object null {"id": "6310a3c1402ff101029e99df", "email": "", "name": "", "name_sort": "", "avatar_feed_url": "", "avatar_thumbnail_url": "", "avatar_profile_large_url": "", "avatar_profile_url": "", "slug": "", "created_at": "2022-09-01T12:21:21Z", "updated_at": "2023-08-09T17:14:27Z", "bio": null, "short_bio": "", "visitor": false, "tz": "Asia/Kolkata", "follow_discussion_allowed": true, "superadmin": false, "tours_seen": [], "phone": null, "removed": false, "role": "admin", "group_ids": []} attributes of content owner.
owner string null "6310a3c1402ff101029e99df" ID of the content owner.
archived boolean false true Archival state of the content. Archived content is filtered from certain pages and API interactions.
assignee_id string null "5ce4238567e6e238d0000001" ID of user assigned to content.
attachments array [] [{ "id": "5ce42cae67e6e2ac72000001", "url": "https://kapost-files-sample.s3.amazonaws.com/uploads/asset/file/5ce42cae67e6e2ac72000001/kapost-sample-img.jpg", "filename": "kapost-sample-img.jpg", "updated_at": "2019-05-21T16:52:03Z", "image_attributes": { "caption": "Sample attachment caption", "alt": "Sample attachment alternative text", "title": "Sample attachment title" } }] Array of attachments on content.
campaign_ids array [] ["5ce4238567e6e238d0000002"] Array of initiative IDs.
content string "" "<p>Sample content HTML</p>" Text body of content. Is blank when content type does not support text.
content_type string "5ce4238567e6e238d0000003" Content type ID.
creator_id string null "5ce4238567e6e238d0000004" ID of user who created content.
custom_fields array [] [{ "id": "5c8a8ede67e6e27b40000000", "field_type": "text", "display_label": "Sample Custom Field Label", "name": "sample_custom_field_name", "default_value": "default text", "created_at": "2019-03-14T17:26:54Z", "select_value_ids": {}, "archived_value_ids": [], "options": { "editor_or_admin_only": false, "required_field": false, "html": false, "multiline": false, "show_character_count": false, "api_only": false }, "newsroom_id": "5c1aa60067e6e242d500003a", "visible_in_previews": false, "visible_in_insights": false, "instructions": "Sample instructions", "value": "Sample Custom Field Text" }] Values and attributes of custom fields on content.
factory_url string "https://kapost.com/posts/example-content-1" Canonical content URL.
id string "5ce4238567e6e238d0000005" Content ID.
last_updated_by object null { "id": "5c1aa5fd67e6e242d500001b", "email": "sample-user@kapost.com", "name": "Sample User", "avatar_feed_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_thumbnail_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_profile_large_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_profile_url": "https://app.kpst.me/assets/default-avatar.png", "slug": "sample-user", "created_at": "2018-12-19T20:11:41Z", "updated_at": "2019-04-15T16:41:27Z", "bio": "Sample user bio", "short_bio": "Sample truncated bio", "visitor": false, "tz": "America/Denver", "follow_discussion_allowed": true, "tours_seen": [], "phone": "555-900-5595" } User who most recently updated content.
library_tracking_url string null "http://bit.ly/2LWvBUp" URL for sharing published version of content.
media_url string null "https://kapost-files-sample.s3.amazonaws.com/kapost/5c1aa60067e6e242d5000001/studio/content/5cd31e3f67e6e255e5000001/revisions/1557339788-eba07587-63f4-4585-bb32-50a2c742da43/kapost-sample-img.jpg" URL of gallery content file.
next_task string "Completed" "publish content to blog" Description of next task. Value is "Completed" if all tasks are completed.
persona_ids array [] ["5ce4238567e6e238d0000006"] IDs of selected content personas.
preferred_title string "(no title)" "Sample content title" Content title with default value.
progress_stage string "planned" "in_progress" Current content stage. Value is one of: "planned", "in_progress", "complete".
published_date string null "2019-05-17T16:07:30Z" Datetime when content was most recently published.
published_url string "" "https://example.com/blog-path/content-path" URL of published content.
slug string "sample-content-slug" URL-safe string generated from content title. Unique across all content.
stage_ids array [] ["5ce4238567e6e238d0000007"] IDs of selected content stages.
state string "production" "production" Description of current content state. Value is one of: "production", "promotion", "completed"
tags array [] ["sample_tag_1", "sample_tag_2"] Array of CMS tags
title string null "Sample content title" Content title.
updated_at string "2019-05-17T16:07:30Z" Datetime content was last updated by a user.

Dynamic Detail

The content API supports a dynamic content response using the columns parameter. Responses include a default set of fields in addition to fields specified by columns.

Method

GET https://example.kapost.com/api/v1/content?columns[]=content_number&columns[]=published_urls&...

GET https://example.kapost.com/api/v1/content?gallery=true&columns[]=content_number&columns[]=published_urls&...

GET https://example.kapost.com/api/v1/content/<content_id>?columns[]=content_number&columns[]=published_urls&...

Example Response

Example response from querying https://example.kapost.com/api/v1/content?columns[]=synced_to_gallery_date&columns[]=library_tracking_url&per_page=1&page=5

{
  "response": [
    {
      "id": "5cdc6497c8f1aa003200000c",
      "slug": "sample-content",
      "url": "https://example.kapost.com/posts/test-other-xml-rpc",
      "status": null,
      "locked": false,
      "content_type": "550098cbc999d7822d000024",
      "updated_at": "2019-05-15T19:13:28.174000Z",
      "deleted_at": null,
      "created_at": "2019-05-15T19:12:23Z",
      "author": "4da754c5514e390ae100008d",
      "published": true,
      "published_url": "http://testwp1.example.kapost.com/?p=590919",
      "published_urls": [
        {
          "external_site_name": "Sample XML-RPC",
          "published_url": "http://testwp1.example.kapost.com/?p=590919"
        }
      ],
      "progress_stage": "in_progress",
      "completed_date": null,
      "synced_to_gallery_date": "2019-05-21T10:10:59Z",
      "library_tracking_url": "http://bit.ly/2HHPlqF"
    }
  ],
  "count": 1,
  "pagination": {
    "previous": 4,
    "next": 6,
    "current": 5,
    "per_page": 1,
    "count": 986,
    "pages": 986
  }
}
Field Name Field Type Default Value Example Value Description
acl object {} { "group_ids": [], "user_ids": ["5c1aa5fd67e6e242d500001b"], "access_summary": "PRIVATE_INSTANCE" } IDs of groups and users that can view content. The value of access_summary is one of: "PRIVATE", "PUBLIC", "PRIVATE_INSTANCE", "PRIVATE_MEMBERS".
added_to_collection_date object {} { "03b1a334-f976-467f-aa24-8f78ddcf31a2": "2019-05-21T20:47:17Z", "84ad822c-0b30-4ca6-95a4-b5c7337666cf": "2019-05-21T20:47:17Z" } Dates that content was added to gallery collections. Object keys are gallery collection IDs, object values are the datetimes content was added.
added_to_collection_dates array [] [{ "collection_id": "03b1a334-f976-467f-aa24-8f78ddcf31a2", "added_date": "2019-05-21T20:47:17Z" }, { "collection_id": "84ad822c-0b30-4ca6-95a4-b5c7337666cf", "added_date": "2019-05-21T20:47:17Z" }] Array of dates that content was added to gallery collections.
archived boolean false true Archival state of the content. Archived content is filtered from certain pages and API interactions.
assigned_date string null "2019-05-08T18:21:51Z" Datetime that content was assigned to current author.
attachments array [] [{ "id": "5ce42cae67e6e2ac72000001", "url": "https://kapost-files-sample.s3.amazonaws.com/uploads/asset/file/5ce42cae67e6e2ac72000001/kapost-sample-img.jpg", "filename": "kapost-sample-img.jpg", "updated_at": "2019-05-21T16:52:03Z", "image_attributes": { "caption": "Sample attachment caption", "alt": "Sample attachment alternative text", "title": "Sample attachment title" } }] Array of attachments on content.
author string null "5c1aa5fd67e6e242d500001b" ID of user assigned to content.
author_details object null { "id": "5c1aa5fd67e6e242d500001b", "email": "sample-user@kapost.com", "name": "Sample User", "avatar_feed_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_thumbnail_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_profile_large_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_profile_url": "https://app.kpst.me/assets/default-avatar.png", "slug": "sample-user", "created_at": "2018-12-19T20:11:41Z", "updated_at": "2019-04-15T16:41:27Z", "bio": "Sample user bio", "short_bio": "Sample truncated bio", "visitor": false, "tz": "America/Denver", "follow_discussion_allowed": true, "tours_seen": [], "phone": "555-900-5595" } Details of user assigned to content.
available_actions array [] ["add_campaigns", "add_tags", "archive", "copy_tags", "delete", "duplicate", "remove_initiatives", "set_progress_stage", "sync_to_gallery", "unsync_from_gallery", "update_tasks"] List of content modifications available to current user. The possible actions are: "publish", "publish_as_draft, "add_campaigns", "add_categories", "add_visibility", "add_tags", "add_personas", "add_buying_stages", "copy_tags", "duplicate", "remove_initiatives", "change_type", "sync_to_gallery", "unsync_from_gallery".
body_fragment string null "Sample HTML-sanitized body" HTML-sanitized version of "content" field.
body_type string "any_file" Body type of content. Possible values are: "any_file", "audio", "document", "eloqua_email", "eloqua_landing_page", "event", "facebook", "google_doc", "html", "linkedin", "marketo_email", "marketo_landing_page", "no_body", "pardot_email", "photo", "social_media", "twitter", "video", "webinar"
campaign_details array [] [{ "id": "5c1d2ea667e6e21c5700000b", "name": "Sample Initiative", "created_at": "2018-12-21T18:19:18Z", "updated_at": "2019-01-14T15:57:22Z", "start_date": "2018-12-03T07:00:00Z", "end_date": "2018-12-24T07:00:00Z", "newsroom_id": "5c1aa60067e6e242d500003a" }] List of initiatives that contain content.
campaigns array [] ["5c1d2ea667e6e21c5700000b"] List of IDs of initiatives that contain content.
can_destroy boolean false true Whether or not the current user can delete content.
can_modify boolean false true Whether or not the current user can update content.
categories array [] ["sample_category_1", "sample_category_2"] Content categories
categories_array array [] ["sample_category_1", "sample_category_2"] Content categories. Same as "categories" field.
collection_uids array [] ["03b1a334-f976-467f-aa24-8f78ddcf31a2", "84ad822c-0b30-4ca6-95a4-b5c7337666cf"] List of IDs of gallery collections that contain content. Available only if gallery=true is included in query.
completed_date string null "2019-05-21T21:52:36Z" Datetime content was moved to "Complete" stage.
content string "" "

Sample content HTML

"		 Text body of content. Is blank when content type does not support text.
content_file object null { "id": "5cd31eab67e6e255e5000003", "updated_at": "2019-05-08T18:23:39Z", "url": "https://kapost-files-sample.s3.amazonaws.com/kapost/5c1aa60067e6e242d5000001/studio/content/5cd31e3f67e6e255e5000001/revisions/1557339788-eba07587-63f4-4585-bb32-50a2c742da43/kapost-sample-img.jpg", "filename": "kapost-sample-img.jpg", "extension": "jpg", "size": 180326, "public": true, "subdomain": "sample", "permanent_url": "https://sample.kpst.me/api/content/5cd31e3f67e6e255e5000001/content_file_urls/5cd31eab67e6e255e5000003" } Content file information of current content file revision, if a content file has been uploaded.
content_file_format string { "name": "any_file", "extensions": ["swf", "flv", "avi", "mpg", "mpeg", "mov", "wmv", "mp4", "m4v", "ogv", "mkv", "webm", "qt", "mp3", "rm", "wma", "aac", "ogg", "wav", "aiff", "mid", "jpg", "jpeg", "gif", "png", "psd", "tif", "tiff", "bmp", "dng", "raw", "indd", "3fr", "arw", "bmp", "cr2", "crw", "dcr", "erf", "ico", "mos", "mrw", "nef", "odd", "orf", "pef", "ppm", "raf", "webp", "x3f", "xcf", "xps", "pdf", "doc", "docx", "rtf", "xls", "xlsx", "xlsm", "ots", "ods", "odt", "txt", "htm", "html", "ppt", "pptx", "log", "csv", "ics", "xml", "vst", "md", "markdown", "eml", "key", "key.zip", "keynote", "msg", "oft", "abw", "djvu", "docm", "lwp", "pages", "pages.zip", "rst", "sdw", "tex", "wpd", "wps", "zabw", "odp", "pps", "ppsx", "sda", "numbers", "numbers.zip", "sdc", "gdoc", "dotx", "json", "srt", "zip", "rar", "7z", "wopitest", "zip", "rar", "7z", "dwg", "dxf", "azw", "azw3", "azw4", "cbc", "cbr", "cbz", "chm", "epub", "fb2", "htm", "htmlz", "lit", "lrf", "mobi", "pdb", "pml", "prc", "rb", "snb", "tcr", "txtz", "ai", "cdr", "cgm", "emf", "eps", "ps", "sk", "sk1", "svg", "svgz", "vsd", "wmf"] } Content file type description and allowed extensions.
content_number integer null 15 Sequential ID of content, if enabled.
content_thumbnail_url string null "data:image/gif;base64,R0lGODlhAQABAIABAAAAAP///yH5BAEAAAEALAAAAAABAAEAQAICTAEAOw%3D%3D" Thumbnail URL used for previewing media within social content (Facebook, LinkedIn, etc).
content_type string "5cd31e3f67e6e255e5000001" ID of content type.
content_type_details object { "background_color": "rgb(187, 31, 0)", "body_type": "any_file", "display_name": "Case Study", "field_name": "case_study", "icon": "words", "icon_css_class": "words", "id": "5c8a8f5e67e6e27b40000003", "newsroom_id": "5c1aa60067e6e242d500003a", "updated_at": "2019-05-23T13:03:39Z" } Content type information.
created_at string "2019-05-28T13:21:50Z" Datetime content was created.
creator string "5c1aa5fd67e6e242d500001b" ID of user who created content.
creator_details object { "id": "5c1aa5fd67e6e242d500001b", "email": "example@kapost.com", "name":"Sample Account", "avatar_feed_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_thumbnail_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_profile_large_url": "https://app.kpst.me/assets/default-avatar.png", "avatar_profile_url":"https://app.kpst.me/assets/default-avatar.png", "slug":"sample-account", "created_at": "2018-12-19T20:11:41Z", "updated_at": "2019-05-23T20:14:40Z", "bio": "Synthesize back-end bandwidth", "short_bio": "Synthesize back-end bandwidth", "visitor": false, "tz": "America/Denver", "follow_discussion_allowed": true, "tours_seen": ["canvas_plans_manage_access", "timeline_edit", "annotations_mode_button"], "phone": "555-303-3030" } Information of user who created content.
currently_editing array [] [{ "id": "5c1aa5fd67e6e242d500001b", "name": "Sample User", "avatar_url": "https://app.kpst.me/assets/default-avatar.png", "last_seen": 1559051943 }] List of users currently editing the content.
custom_field_value_ids object {} { "5cae50ac67e6e2539300000f": "5cae50ac67e6e2539300000e", "5cd080a267e6e23a03000002": [], "5cd3132f67e6e23a0300000c": ["5cd3132f67e6e23a0300000a", "5cd3132f67e6e23a0300000b"], "5cd3136a67e6e23a0300000f": ["5cd3136a67e6e23a0300000d"], "5ce6992867e6e24a7f000010": ["5ce6992867e6e24a7f00000e"], "5ce5822067e6e2ac7200000b": "5ce5822067e6e2ac72000009", "5ce69a0467e6e24a7f000013": "5ce69a0467e6e24a7f000011", "5cd213ec67e6e23a03000007": [], "5ce6977767e6e24a7f00000d": ["5ce6977767e6e24a7f00000b"] } IDs of selected custom field values. Object keys are custom field IDs, object values are custom field value IDs.
custom_field_values object {} { "5cb4e1d967e6e2cd06000000": "Multiline readonly", "5cb4e1f167e6e2cd06000001": "Html readonly field", "5c8a8ede67e6e27b40000000": "", "5cae50ac67e6e2539300000f": "unlimited", "5c8a8f2867e6e27b40000002": { "id": "5ce6a02667e6e24a7f000019", "previewable": false, "uploaded_by": "5c1aa5fd67e6e242d500001b", "file_name": "kapost-sample-img.jpg", "file_url": "https://kapost-files-sample.s3.amazonaws.com/uploads/asset/file/5ce6a02667e6e24a7f000001/kapost-sample-img.jpg", "file_extension": "jpg", "created_at": "2019-05-23T13:29:10Z", "updated_at": "2019-05-23T13:29:15Z", "preview_url": "https://s3.amazonaws.com/kapost-files-prod/default/no_preview.png", "image_title": null, "image_caption": null, "image_alt": null, "public": true, "subdomain": "development" }, "5cd080a267e6e23a03000002": null, "5cd3132f67e6e23a0300000c": ["corporate-strategy","digital-content"], "5cd3136a67e6e23a0300000f": ["aerospace"], "5ce6992867e6e24a7f000010": ["Education"], "5ce5822067e6e2ac7200000b": "consultant", "5ce69a0467e6e24a7f000013": "Sample User", "5cd213ec67e6e23a03000007": ["sample-value"], "5cb4f34567e6e2d512000001": "46baed47-5d42-42a4-af5d-3b7b248484c2", "5cb4a7c967e6e25a08000010": "27ff2696-a06a-4f4d-a794-95d084fe4ddc", "5ce6977767e6e24a7f00000d": ["technologies"] } Values of content custom fields. Includes previews of uploaded files and their URLs. Has less detail than custom_fields_details.
custom_fields object {} { "5cb4e1d967e6e2cd06000000": "Multiline readonly", "5cb4e1f167e6e2cd06000001": "Html readonly field", "5c8a8ede67e6e27b40000000": "", "5cae50ac67e6e2539300000f": "unlimited", "5c8a8f2867e6e27b40000002": "5ce6a02667e6e24a7f000019", "5cd080a267e6e23a03000002": [], "5cd3132f67e6e23a0300000c": ["corporate-strategy","digital-content"], "5cd3136a67e6e23a0300000f": ["aerospace"], "5ce6992867e6e24a7f000010": ["Education"], "5ce5822067e6e2ac7200000b": "consultant", "5ce69a0467e6e24a7f000013": "Sample User", "5cd213ec67e6e23a03000007": ["value"], "5cb4f34567e6e2d512000001": "46baed47-5d42-42a4-af5d-3b7b248484c2", "5cb4a7c967e6e25a08000010": "27ff2696-a06a-4f4d-a794-95d084fe4ddc", "5ce6977767e6e24a7f00000d": ["technologies"] } Values of content custom fields. Has less detail than custom_fields_values or custom_fields_details.
custom_fields_details object [] [{ "id": "5cb4e1d967e6e2cd06000000", "display_label": "Multiline Readonly Field", "field_type": "text", "html": false,"value": "Multiline readonly", "value_id": null,"updated_at": "2019-04-15T19:56:09Z" }, { "id": "5cb4e1f167e6e2cd06000001", "display_label": "Html Readonly Field", "field_type": "text", "html":true,"value": "Html readonly field", "value_id":null,"updated_at": "2019-04-15T19:56:33Z" }, { "id": "5c8a8ede67e6e27b40000000", "display_label": "Corporate Structure", "field_type": "text", "html":false,"value":null,"value_id":null,"updated_at": "2019-03-14T17:26:54Z" }, { "id": "5cae50ac67e6e2539300000f", "display_label": "Restrictions", "field_type": "select", "html":false,"value": "unlimited", "value_id": "5cae50ac67e6e2539300000e", "updated_at": "2019-05-23T13:28:52Z" }, { "id": "5c8a8f2867e6e27b40000002", "display_label": "Legal document", "field_type": "file", "html":false,"value": "https://kapost-files-sample.s3.amazonaws.com/uploads/asset/file/5ce6a02667e6e24a7f000000/kapost-sample-img.jpg", "value_id":null,"updated_at": "2019-03-14T17:28:08Z" }, { "id": "5cd080a267e6e23a03000002", "display_label": "Sample CF", "field_type": "multiselect", "html":false,"value":null,"value_id":null,"updated_at": "2019-05-06T18:44:50Z" }, { "id": "5cd3132f67e6e23a0300000c", "display_label": "Tags: Business", "field_type": "multiselect", "html":false,"value": ["digital", "corporate"], "value_id": ["5cd3132f67e6e23a0300000a", "5cd3132f67e6e23a0300000b"], "updated_at": "2019-05-23T13:26:16Z" }, { "id": "5cd3136a67e6e23a0300000f", "display_label": "Industry", "field_type": "multiselect", "html":false,"value": ["Aerospace"], "value_id": ["5cd3136a67e6e23a0300000d"], "updated_at": "2019-05-23T12:55:01Z" }, { "id": "5ce6992867e6e24a7f000010", "display_label": "Buying Stages", "field_type": "multiselect", "html":false,"value": ["Education"], "value_id": ["5ce6992867e6e24a7f00000e"], "updated_at": "2019-05-23T12:59:20Z" }, { "id": "5ce5822067e6e2ac7200000b", "display_label": "Custom Properties", "field_type": "select", "html":false,"value": "consultant", "value_id": "5ce5822067e6e2ac72000009", "updated_at": "2019-05-22T17:32:05Z" }, { "id": "5ce69a0467e6e24a7f000013", "display_label": "Marketing Communications Director", "field_type": "select", "html":false,"value": "Sample Marketer", "value_id": "5ce69a0467e6e24a7f000011", "updated_at": "2019-05-23T13:03:00Z" }, { "id": "5cd213ec67e6e23a03000007", "display_label": "Multiselect", "field_type": "multiselect", "html":false,"value": ["value"], "value_id": [], "updated_at": "2019-05-07T23:25:32Z" }, { "id": "5cb4f34567e6e2d512000001", "display_label": "Document ID", "field_type": "text", "html":false,"value": "46baed47-5d42-42a4-af5d-3b7b248484c2", "value_id":null,"updated_at": "2019-04-15T21:10:29Z" }, { "id": "5cb4a7c967e6e25a08000010", "display_label": "External ID", "field_type": "text", "html":false,"value": "27ff2696-a06a-4f4d-a794-95d084fe4ddc", "value_id":null,"updated_at": "2019-04-15T15:48:25Z" }, { "id": "5ce6977767e6e24a7f00000d", "display_label": "Division", "field_type": "multiselect", "html":false,"value": ["Technology"], "value_id": ["5ce6977767e6e24a7f00000b"], "updated_at": "2019-05-23T12:52:07Z" }] Values and details of content custom fields.
deleted_at string null "2019-05-28T13:21:50Z" Time content was deleted, if it was deleted.
discussion_url string "https://example.kapost.com/discussions/5ce69fd567e6e24a7f000016" Content discussion URL.
download_url string null "https://kapost-files-sample.s3.amazonaws.com/kapost/5c1aa60067e6e242d5000001/studio/content/5cd31e3f67e6e255e5000001/revisions/1557339788-eba07587-63f4-4585-bb32-50a2c742da00/kapost-sample-img.jpg" URL for downloading content file. Available only if gallery=true is included in query.
event_end_date string null "11/18/14" Start date of content event (Event content type only). Available only for individual content requests, not index requests.
event_start_date string null "10/31/14" Start date of content event (Event content type only). Available only for individual content requests, not index requests.
excerpt string null "test excerpt" Content excerpt.
favorite boolean false true True if the current user has favorited the content within gallery.
favorite_count integer 0 12 Number of users who have favorited the content within gallery.
favorite_dates array [] ["2019-05-28T19:27:31Z"] List of datetimes that content was favorited within gallery.
favorited_by_users array [] ["5c1aa5fd67e6e242d500001b"] List of IDs of users who have favorited content
field_locks object { "body": { "locked": false } } Front-end locked content fields
full_content_type object { "background_color": "rgb(131, 185, 165)", "body_type": "event", "display_name": "Sample Event", "field_name": "event", "icon": "event", "icon_css_class": "event", "id": "5c1aa60e67e6e242d5005014", "newsroom_id": "5c1aa60067e6e242d500003a", "updated_at": "2019-02-22T20:30:42Z" } Content type details
gallery_bundle_can_download boolean true false True if the content is allowed to be downloaded from bundles within gallery. Available only if gallery=true is included in query.
gallery_bundle_can_share boolean true false True if the content is allowed to be shared from bundles within gallery. Available only if gallery=true is included in query.
gallery_bundle_settings_overridden boolean false true True if the content is allowed to be downloaded from bundles within gallery. Available only if gallery=true is included in query.
gallery_can_bundle boolean false true True if gallery_can_bundle, gallery_bundle_can_download or gallery_bundle_can_share has been manually set by a user. Available only if gallery=true is included in query.
gallery_can_download boolean true false True if the content is allowed to be downloaded within gallery. Available only if gallery=true is included in query.
gallery_can_share boolean true false True if the content is allowed to be downloaded within gallery. Available only if gallery=true is included in query.
gallery_preview_revision object null {"id": "5ceeebd667e6e24a7f000066", "url": "https://kapost-files-sample.s3.amazonaws.com/kapost/5c1aa60067e6e242d5000001/studio/content/5ce69fd567e6e24a7f000001/revisions/1559161806-f565d915-e6df-40c3-8b41-21296013ca01/kapost-sample-img.jpg", "filename": "kapost-sample-img.jpg", "extension": "jpg", "size": 185655 } Selected content file revision, if it has been specified. Available only if gallery=true is included in query.
gallery_preview_revision_id string null "5ceeebd667e6e24a7f000066" ID of selected content file revision, if it has been specified. Available only if gallery=true is included in query.
gallery_share_settings array ["published_url", "tracking_url", "email", "twitter", "facebook", "linkedin"] ["email", "linkedin"] List of channels to which content can be shared in gallery. Available only if gallery=true is included in query.
gallery_viewer_compatibility string "none" "photo" Content preview type in gallery. Value is one of: "none", "pdf", "google", "photo", "video", "audio". Available only if gallery=true is included in query.
google_file_id string null "1Zo53yj2cqfURfoZypuSA3pzCMVrFRAFABrgMPOJnf00" ID of content external Google file, if content is of a Google Drive body type. Available only if gallery=true is included in query.
google_preview_url string null "https://docs.google.com/document/d/1Zo53yj2cqfURfoZypuSA3pzCMVrFRAFABrgMPOJnf00/preview" URL of Google document preview, if content is of a Google Drive body type. Available only if gallery=true is included in query.
id string "5ceeee4a67e6e24a7f000068" ID of content
initiatives_details array [] [{ "id": "5c1d2ea667e6e21c5700000b", "name": "Sample Initiative", "created_at": "2018-12-21T18:19:18Z", "updated_at": "2019-01-14T15:57:22Z", "start_date": "2018-12-03T07:00:00Z", "end_date": "2018-12-24T07:00:00Z", "newsroom_id": "5c1aa60067e6e242d500003a" }] List of details of initiatives that contain content.
instance object { "id": "5c1aa60067e6e242d500003a", "name": "Sample Instance", "subdomain": "sample" } Details of instance that content belongs to.
kapost_url string "https://example.kapost.com/posts/sample-content" Canonical URL of content.
latitude float null 40.018912 Latitude of content, if it is of an Event body type. Available only for individual content requests, not index requests.
library_tracking_url string null "http://bit.ly/2HHPlqF" URL of published content for sharing from gallery.
localized_from_id string null "5ceeebd667e6e24a7f000077" Parent content ID that content was localized from.
locked boolean false true True if content is locked in studio.
longitude float null -105.2772989 Longitude of content, if it is of an Event body type. Available only for individual content requests, not index requests.
marketing_automation_url string null "/posts/sample_content/marketing_automation_content_preview?version=v1" Path for requesting content marketing automation preview
media_url string null "https://kapost-files-sample.s3.amazonaws.com/kapost/5c1aa60067e6e242d5000001/studio/content/5ce69fd567e6e24a7f000001/revisions/1559161806-f565d915-e6df-40c3-8b41-21296013ca01/kapost-sample-img.jpg" URL of gallery revision.
newsroom_id string "5c1aa60067e6e242d500003a" ID of instance that content belongs to.
next_task object null { "id": "5ceefdd467e6e24a7f000080", "completed": false,"completion_action": "manual", "deadline": "2019-05-31T23:00:00Z", "deadline_offset": null,"deadline_offset_unit": null,"deadline_offset_task_id": null,"deadline_offset_task_action": null,"description": "Sample Task", "position": 0,"state": 4, "owner_ids": ["5c1aa5fb67e6e242d5000000"] } Next task details.
next_task_deadline string null "2019-05-31T23:00:00Z" Next task deadline.
next_task_owner array [] ["5c1aa5fb67e6e242d5000000"] ID of users assinged to next task.
next_task_title string null "Sample Task" Title of next task.
payment float null 100.00 Payment rate of content, if set. Available only for individual content requests, not index requests.
personas array [] ["5cef009167e6e24a7f000083"] List of content persona IDs.
pinned boolean false true True if the content is pinned within a gallery collection. Available only if gallery=true is included in query.
pinned_collection_rank object {} { "03b1a334-f976-467f-aa24-8f78ddcf31a2": 0 } Object containing index positions in which content is pinned within gallery collections, if it is pinned. Keys are gallery collections, values are index positions within pinned content. Available only if gallery=true is included in query.
place_id string null "ChIJOdYIYCjsa4cRmLDf_kl6yK0" Google Maps ID of event location, if content is of an Event body type. Available only for individual content requests, not index requests.
preferred_title string "(no title)" "Sample Content Title" Content title with default value.
preferred_title_sort string "(no title)" "sample content title" Lower-case version of preferred_title to enable sorting content.
previewable_custom_field_values object {} { "5cd3136a67e6e23a0300000f": ["Aerospace"], "5cd3132f67e6e23a0300000c": ["Digital", "Services"] } Values of custom fields that have "Show in Studio Preview and Gallery" setting enabled.
progress_stage string "planned" "in_progress" Current content stage. Value is one of: "planned", "in_progress", "complete".
publish_destination string null "Sample Wordpress Blog" Formatted name of destination content was published to.
published boolean false true True if content has been published.
published_date string null "2019-05-17T16:07:30Z" Datetime content was most recently published
published_url string null "https://example.com/blog/sample-content" First published URL of content.
published_urls array [] [{ "external_site_name": "Example Blog", "published_url": "https://example.com/blog/sample-content" }, { "external_site_name": "Siemens Prod", "published_url": null }] List of destinations content has been published to.
repository_notes string null "

Sample gallery notes.

"		 Notes for explaining content usage and purpose in gallery.
salesforce_shared_with_ids array [] ["0033000000GvHjL"] List of Salesforce contacts, leads and opportunities with which content has been shared within Salesforce Gallery Application.
slug string "sample-content" URL-safe string generated from content title. Unique across all content.
stages array [] ["5cef009167e6e24a7f000099"] List of content stage IDs.
synced_to_gallery_date string null "2019-05-29T22:03:59Z" Datetime content was added to gallery.
tags array [] ["sample_tag_1", "sample_tag_2"] Array of CMS tags
task_deadlines array [] [{ "description": "Sample Task", "deadline": "2019-05-30T23:00:00Z", "smart_deadline": false }] Array of task deadlines
tasks_begin_at string null "2019-05-17T16:07:30Z" Earliest content task deadline. Available only for individual content requests, not index requests.
tasks_end_at string null "2019-05-17T16:07:30Z" Latest content task deadline. Available only for individual content requests, not index requests.
thumbnail_url string null "https://kapost-files-sample.s3.amazonaws.com/kapost/5c1aa60067e6e242d5000001/studio/content/5ced94e567e6e24a7f000001/thumbnails/1559170523-11c32998-3390-47a6-95e1-cd7960faed01/thumbnail/kapost-sample-img.png" URL of content thumbnail.
timezone_name string null "America/Denver" Name of timezone where event is located, if content is of an Event body type. Available only for individual content requests, not index requests.
title string null "sample content title" Title of content.
updated string "2019-05-29T22:34:18Z" Datetime content was last updated.
updated_at string "2019-05-29T22:34:18.457000Z" Raw datetime content was last updated.
url string "https://example.kapost.com/posts/sample-content" Canonical URL of content.
viewer_compatibility string "none" "video" Content preview type in studio. Value is one of: "none", "pdf", "google", "photo", "video", "audio"
webinar_playback_url string null "https://example.com/webinars/recording-file.m4a" URL of recorded webinar content, if content is a webinar and the webinar has occurred.
wordcount integer null 1911 Word count of content "content" field.
social_media_channel string null Twitter Social Media Channel for Social Media Content.