Get a preview hydrated component by ID | Documentation

{
  "sys": {
    "id": "string",
    "type": "Fragment",
    "archivedAt": "string",
    "archivedBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "archivedVersion": 1.1,
    "componentType": {
      "sys": {
        "linkType": "Contentful:ComponentType",
        "type": "ResourceLink",
        "urn": "string"
      }
    },
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "environment": {
      "sys": {
        "id": "string",
        "linkType": "Environment",
        "type": "Link"
      }
    },
    "firstPublishedAt": "string",
    "publishedAt": "string",
    "publishedBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "publishedCounter": 1.1,
    "publishedVersion": 1.1,
    "space": {
      "sys": {
        "id": "string",
        "linkType": "Space",
        "type": "Link"
      }
    },
    "updatedAt": "string",
    "updatedBy": {
      "sys": {
        "id": "string",
        "linkType": "User",
        "type": "Link"
      }
    },
    "variant": "string",
    "variantDimension": "string",
    "variantType": "string"
  },
  "viewports": [
    {
      "id": "string",
      "query": "string",
      "displayName": "string",
      "previewSize": "string"
    }
  ],
  "nodes": [
    {
      "componentType": {
        "sys": {
          "linkType": "Contentful:ComponentType",
          "type": "ResourceLink",
          "urn": "string"
        }
      },
      "contentBindings": "string",
      "contentProperties": {},
      "designProperties": {},
      "id": "string",
      "slots": {}
    }
  ],
  "errors": [
    {
      "fieldPath": "string",
      "message": "string"
    }
  ],
  "extensions": {
    "personalization": {
      "profile": {
        "id": "string",
        "stableId": "string",
        "random": 1.1,
        "audiences": [
          "string"
        ],
        "traits": {},
        "location": {
          "coordinates": {
            "latitude": 1.1,
            "longitude": 1.1
          },
          "city": "string",
          "postalCode": "string",
          "region": "string",
          "regionCode": "string",
          "country": "string",
          "countryCode": "string",
          "continent": "string",
          "timezone": "string"
        },
        "session": {
          "isReturningVisitor": true,
          "landingPage": {
            "path": "string",
            "query": {},
            "referrer": "string",
            "search": "string",
            "url": "string"
          },
          "count": 1.1,
          "activeSessionLength": 1.1,
          "averageSessionLength": 1.1,
          "id": "string"
        }
      },
      "experiences": [
        {
          "experienceId": "string",
          "variantIndex": 1.1,
          "variants": {}
        }
      ],
      "changes": [
        {
          "id": "string",
          "meta": {
            "optimizationId": "string",
            "variantIndex": 1.1
          },
          "type": "Experience",
          "variantId": "string"
        }
      ]
    },
    "sourceMap": {
      "version": 1,
      "variants": [
        {
          "type": "personalization",
          "id": "string",
          "experienceId": "string",
          "optimizationId": "string",
          "variantId": "string",
          "variantIndex": 1.1
        }
      ],
      "spaces": [
        "string"
      ],
      "environments": [
        "string"
      ],
      "locales": [
        "string"
      ],
      "entries": [
        {
          "space": 1.1,
          "environment": 1.1,
          "id": "string"
        }
      ],
      "assets": [
        {
          "space": 1.1,
          "environment": 1.1,
          "id": "string"
        }
      ],
      "layers": [
        {
          "id": "string",
          "kind": "ComponentType"
        }
      ],
      "dataAssemblies": [
        {
          "id": "string",
          "parameters": {},
          "return": {}
        }
      ],
      "nodes": {}
    }
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

environmentIdstringRequired

idstringRequired

Query parameters

access_tokenstringOptional

optimization-profile-idstringOptional

localestringOptional

previewanyOptional

variantstringOptional

Response

200

sysobject

viewportslist of objects

nodeslist of objects

errorslist of objects

extensionsobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl https://preview.xdn.contentful.com/spaces/spaceId/environments/environmentId/components/id \
>	-H "Authorization: Bearer <token>"