Object Reference

When working with the Content API you will be given JSON responses that contain various kinds of objects. This page outlines the reference JSON structure for each type of object that exists in the API.

Most of the time you will request a primary object of a specific type such as a Content or Asset object. Sometimes, there will be other types of objects that form part of the primary one.

Assets

Asset objects only ever appear as part of an asset field object. At present, they can’t be fetched on their own.

Example:

{
  "id": "Gzb7AQ7pOZ",
  "name": "Grimacing Face Balloon",
  "description": "Bright yellow balloon of the grimacing face emoji.",
  "path": "assets/Gzb7AQ7pOZ/grimacing-face-balloon.jpg",
  "url": "https://assets.contento.io/assets/Gzb7AQ7pOZ/grimacing-face-balloon.jpg",
  "extension": "jpg",
  "size": "3.6 MB",
  "mime_type": "image/jpeg",
  "is_image": true,
  "width": 6000,
  "height": 4000
}

Authors

Author objects are only present as part of a content object. They reference the user account of the person who initially created the object.

Example:

{
  "id": "RaDf2yMpL6",
  "name": "Josh Angell",
  "email": "[email protected]",
  "profile_photo_url": "https://assets.contento.io/profile-photos/caX2ahJ8YNRnNgHHqSWVcZIKjilNfMmeJMdS4sL5.jpg"
}

Content

Example:

{
  "id": "RaDf2yMpL6",
  "published_at": "2022-09-27T08:54:06+00:00",
  "slug": "vertical-saas",
  "name": "The Growth of Vertical SaaS",
  "author": {
    "id": "RaDf2yMpL6",
    "name": "Josh Angell",
    "email": "[email protected]",
    "profile_photo_url": "https://assets.contento.io/profile-photos/caX2ahJ8YNRnNgHHqSWVcZIKjilNfMmeJMdS4sL5.jpg"
  },
  "content_type": {
    "id": "RaDf2yMpL6",
    "name": "Blog Post",
    "handle": "blog_post",
    "object_type": "page"
  },
  "fields": {
    "title": {
      "id": "RaDf2yMpL6",
      "name": "Title",
      "handle": "title",
      "help_text": "Used as the H1 on the post detail page.",
      "type": "text",
      "text": "The Growth of Vertical SaaS"
    },
    ...
  }
}

Content Types

Content type objects can appear on content or block objects. At present, they can’t be fetched on their own.

Example:

{
  "id": "RaDf2yMpL6",
  "name": "Blog Post",
  "handle": "blog_post",
  "object_type": "page"
}

Fields

Example:

{
  "id": "RaDf2yMpL6",
  "name": "Title",
  "handle": "title",
  "help_text": "Used as the H1 on the post detail page.",
  "type": "text",
  ...
}

There are many field types that all extend the base field object above. Outlined below are the additional attributes and values each type of field can add to the base field.

Assets

Example:

{
  ...,
  "assets": [
    {
      "sort": 0,
      "asset": {
        ...
      }
    },
    {
      "sort": 1,
      "asset": {
        ...
      }
    }
  ]
}

Blocks

Example:

{
  ...,
  "blocks": [
    {
      "name": "Sign up to our newsletter",
      "sort": 0,
      "fields": {
        "heading": {
          "id": "RaDf2yMpL6",
          "name": "Heading",
          "handle": "heading",
          "help_text": null,
          "type": "text",
          "text": "Sign up to our newsletter"
        },
        ...
      },
      "content_type": {
        "id": "RaDf2yMpL6",
        "name": "CTA",
        "handle": "cta",
        "object_type": "block"
      }
    },
    {
      "name": "Single Image",
      "sort": 1,
      "fields": {
        "image": {
          "id": "w5D7qq47JP",
          "name": "Image",
          "handle": "image",
          "help_text": null,
          "type": "assets",
          "assets": [
            {
              "id": "Gzb7AQ7pOZ",
              "name": "Raimond Klavins 0Gg W5Og Pb Q Unsplash",
              "description": null,
              "path": "assets/Gzb7AQ7pOZ/raimond-klavins-0ggW5og_pbQ-unsplash.jpg",
              "url": "https://assets.contento.io/assets/Gzb7AQ7pOZ/raimond-klavins-0ggW5og_pbQ-unsplash.jpg",
              "extension": "jpg",
              "size": "2.31 MB",
              "mime_type": "image/jpeg",
              "is_image": true,
              "width": 5760,
              "height": 3840
            },
            ...
          ]
        },
        ...
      },
      "content_type": {
        "id": "YPV7lKdvwx",
        "name": "Single Image",
        "handle": "single_image",
        "object_type": "block"
      }
    },
    ...
  ]
}

Content Links

Example:

{
  ...,
  "content_links": [
    {
      "sort": 0,
      "content_link": {
        "id": "c_01H4FYwdW88ayPt0f0F551B51b",
        "published_at": "2022-08-16T18:49:33.000000Z",
        "slug": null,
        "name": "Cow",
        "fields": {
          "title": {
            "id": "D4GjP89jZe",
            "name": "Title",
            "handle": "title",
            "help_text": null,
            "type": "text",
            "text": "Cow"
          },
          ...
        }
      }
    },
    {
      "sort": 1,
      "content_link": {
        "id": "c_01H4G0ERMbEnrr83ZCVan3s9T6",
        "published_at": "2022-08-16T18:49:27.000000Z",
        "slug": null,
        "name": "Dog",
        "fields": {
          "title": {
            "id": "D4GjP89jZe",
            "name": "Title",
            "handle": "title",
            "help_text": null,
            "type": "text",
            "text": "Dog"
          },
          ...
        }
      }
    },
    ...
  ]
}

Date

Example:

{
  ...,
  "date": "2022-08-31T09:16:00+00:00"
}

Decimal

Example:

{
  ...,
  "number": "3.14"
}

Dropdown

Example:

{
  ...,
  "selected_option": {
    "label": "Rick Astley",
    "value": "rick_astley"
  }
}

Integer

Example:

{
  ...,
  "number": 42
}

List

Example:

{
  ...,
  "list": [
    {
      "text": "Never gonna give you up",
      "sort": 1
    },
    {
      "text": "Never gonna let you down",
      "sort": 2
    },
    {
      "text": "Never gonna run around and desert you",
      "sort": 3
    },
    {
      "text": "Never gonna make you cry",
      "sort": 4
    },
    {
      "text": "Never gonna say goodbye",
      "sort": 5
    },
    {
      "text": "Never gonna tell a lie and hurt you",
      "sort": 6
    },
    ...
  ]
}

Long Text

Example:

{
  ...,
  "text": "<p>Glaoch na h\u00c9ireann<br>Chugainn an l\u00e1 is chugainn an d\u00fashl\u00e1n,<br>R\u00e9 na cumhachta is na gl\u00f3ire,<br>\u2018S\u00e9 glaoch na t\u00edre a fhreagr\u00f3im\u00eds,<br>\u00d3 cheithre ch\u00faige na h\u00c9ireann.<\/p>\n\n<p><strong>Curf\u00e1:<\/strong><br>\u00c9ire,\u00c9ire,<br>Is treise sinn mar shlua,<br>Gualainn le gualainn,<br>\u00c9ireoidh linn gan dua.<\/p>"
}

Text

Example:

{
  ...,
  "text": "Hello, sunshine."
}

Toggle

Example:

{
  ...,
  "is_on": true
}

Timestamps

There are two timestamp attributes that can appear on the top level object that you are requesting. For example if you make a request to the /content/{id} endpoint then you’ll get back a single content object. This will contain the timestamps on it as well as the base object, but all other objects that hang off the top level one will not have timestamps on them.

The timestamps refer to the dates the root object was created on or last updated at.

Example:

{
  ...,
  "created_at": "2022-09-15T13:39:40+00:00",
  "updated_at": "2022-09-27T08:59:39+00:00"
}