---
canonical: https://amplience.com/developers/docs/apis/content-management-reference/content-items/
title: "Content items"
description: "API reference for content item endpoints. Covers creating, updating, publishing, archiving, localizing, and searching content items."
audience: Developer
date_published: 2023-08-29
date_modified: 2026-07-05
---

# Content items

**Base URL:** `https://api.amplience.net/v2/content`

> **Note: Authorization and status codes**
> For authorization and status codes see the [API Reference overview](https://amplience.com/developers/docs/apis/content-management-reference/).

## Content items

| Method | Endpoint | Summary |
|--------|----------|---------|
| `PATCH` | `/content-items` | [Update multiple content items](#update-multiple-content-items) |
| `GET` | `/content-items/{contentItemId}` | [Get content item](#get-content-item) |
| `PATCH` | `/content-items/{contentItemId}` | [Update content item](#update-content-item) |
| `POST` | `/content-items/{contentItemId}/archive` | [Archive content item](#archive-content-item) |
| `GET` | `/content-items/{contentItemId}/associations` | [Get content item associations](#get-content-item-associations) |
| `PATCH` | `/content-items/{contentItemId}/delivery-key` | [Assigning a delivery key](#assigning-a-delivery-key) |
| `GET` | `/content-items/{contentItemId}/history` | [List content item history](#list-content-item-history) |
| `POST` | `/content-items/{contentItemId}/localize` | [Localize content item](#localize-content-item) |
| `GET` | `/content-items/{contentItemId}/planned` | [Finding content by epoch](#finding-content-by-epoch) |
| `POST` | `/content-items/{contentItemId}/publish` | [Publish content item](#publish-content-item) |
| `PUT` | `/content-items/{contentItemId}/restore` | [Restore content by content version number](#restore-content-by-content-version-number) |
| `POST` | `/content-items/{contentItemId}/unarchive` | [Unarchive content item](#unarchive-content-item) |
| `POST` | `/content-items/{contentItemId}/unpublish` | [Unpublish content item](#unpublish-content-item) |
| `GET` | `/content-items/{contentItemId}/versions` | [List content item versions](#list-content-item-versions) |
| `GET` | `/content-items/{contentItemId}/versions/{version}` | [Finding content by content version number](#finding-content-by-content-version-number) |
| `GET` | `/content-items/{contentItemId}`<br/>`/versions/{version}/history` | [List content item history for a version](#list-content-item-history-for-a-version) |
| `PATCH` | `/content-items/{contentItemId}/workflow` | [Assigning a workflow state](#assigning-a-workflow-state) |
| `GET` | `/content-items/search/findByIdWithChildren` | [Getting linked child content items](#getting-linked-child-content-items) |
| `GET` | `/content-items/search/findByIdWithParents` | [Getting linked parent content items](#getting-linked-parent-content-items) |
| `GET` | `/content-repositories/{contentRepositoryId}`<br/>`/content-items` | [List content items](#list-content-items) |
| `POST` | `/content-repositories/{contentRepositoryId}`<br/>`/content-items` | [Create content item](#create-content-item) |
| `POST` | `/content-repositories/{contentRepositoryId}`<br/>`/content-items/{sourceContentItemId}` | [Copy content item](#copy-content-item) |
| `POST` | `/hubs/{hubId}/content-items/facet` | [Faceting content items with search by text](#faceting-content-items-with-search-by-text) |
| `POST` | `/hubs/{hubId}/content-items/filter` | [Filtering content items by collection keys](#filtering-content-items-by-collection-keys) |
| `GET` | `/hubs/{hubId}/content-items/find` | [Search content items by text](#search-content-items-by-text) |
| `GET` | `/hubs/{hubId}/delivery-keys/content-item` | [Finding content items by delivery keys](#finding-content-items-by-delivery-keys) |

### Text search query syntax

A simple query syntax is provided to allow full text search on content items. Several characters have special meaning and are reserved:

**Reserved Search Characters**

| Description | Symbol |
| ----------- | ------ |
| Negation Operator | `-` |
| Field Search Operator | `:` |
| Quote (for exact search) | `"` |
| Comma (list multiple search terms) | `,` |

Please note that the text search is case insensitive, and will only display content items within the hub. See the following examples for an explanation of the query syntax:

**Text Search Examples**

| Query | Meaning |
| ----- | ------- |
| `apple` | Find all content items containing the word "apple" |
| `apple orange` | Find all content items containing the words "apple" AND "orange" |
| `apple,orange` | Find all content items containing either "apple" OR "orange" |
| `apple -orange` | Find all content items that contain the word "apple" but NOT "orange" |
| `-apple-orange` | Find all content items that don't contain "apple-orange" (hyphens in the middle of a word are not treated as negation) |
| `label:apple` | Find all content items that contain the word "apple" within the "label" field |
| `"apple:orange"` | Find all content items containing "apple:orange" (quotes must be used to search for a colon character) |
| `apple label:orange` | Find all content items containing the word "apple" anywhere within them, AND the word "orange" in the label field |

### Publishing status values

The `publishingStatus` field appears on all content item responses and describes the relationship between the current version and the last published version:

| Value | Meaning |
|-------|---------|
| `NONE` | The content item has never been published |
| `EARLY` | The content item has been published, but changes have been made since the last publish |
| `LATEST` | The content item has been published and no changes have been made since. The published version is current |
| `UNPUBLISHED` | The content item was published and has since been unpublished |

### Workflow state

The `workflow.state` field on a content item response contains the ID of the assigned [Workflow State](https://amplience.com/developers/docs/apis/content-management-reference/workflows-localization/#workflows) resource. Use the Workflow States endpoints to list available states for a hub or retrieve a state by ID. The field is absent when no workflow state is assigned.

### Content item response links

Most content item API responses include a standard set of HAL `_links` describing the actions and related resources available. The examples throughout this page show an abbreviated set of links for readability. The full set returned in a typical content item response looks like this:

```json
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    },
    "unpublish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/unpublish"
    },
    "linked-content": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "content-item-with-children": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item-with-parents": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithParents?id=00112233-4455-6677-8899-aabbccddeeff"
    },
    "update": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?ignoreSchemaValidation}",
      "templated": true
    },
    "restore-version": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/restore"
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-item-version": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}",
      "templated": true
    },
    "content-item-versions": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}",
      "templated": true
    },
    "content-item-history": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history{?page,size,sort}",
      "templated": true
    },
    "copy": {
      "href": "https://api.amplience.net/v2/content/content-repositories/{id}/content-items?sourceContentItemId=00112233-4455-6677-8899-aabbccddeeff",
      "templated": true
    },
    "unarchive": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/unarchive"
    },
    "archive": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/archive"
    },
    "set-delivery-key": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/delivery-key"
    },
    "set-locale": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/locale"
    },
    "create-localizations": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localize"
    },
    "localizations": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/localizations{?page,size,sort}",
      "templated": true
    },
    "localization-jobs": {
      "href": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}",
      "templated": true
    },
    "edition-slot-associations": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations"
    },
    "edit-workflow": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/workflow"
    }
  }
```

> **Note: Which links you'll actually see**
> The exact set of links returned can vary slightly by content item state. Endpoints that return a partial or list representation may include a smaller subset of these links rather than the full set shown above.

### Update multiple content items

`PATCH /content-items`

<small>`https://api.amplience.net/v2/content/content-items`</small>

Update Multiple Content Items

**Request Body**

Content-Type: `application/json`

<details>
<summary>Request example</summary>

```json
[
  {
    "body": {
      "_meta": {
        "name": "Name",
        "schema": "http://deliver.bigcontent.io/schema/nested/nested-type.json"
      },
      "heading": "Heading",
      "link": "http://anyafinn.com/buymore?campaign=shouting"
    },
    "label": "Label",
    "version": 1,
    "folderId": "00112233445566778899aabb",
    "assignees": "00112233445566778899aabb",
    "id": "00112233-4455-6677-8899-aabbccddeeff"
  }
]
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 207 | Update Multiple Content Items response |

<details>
<summary>Response Example (207)</summary>

```json
{
  "results": [
    {
      "id": "00112233-4455-6677-8899-aabbccddeeff",
      "status": 200,
      "code": "SUCCESS",
      "level": "INFO"
    }
  ]
}
```

</details>

### Get content item

`GET /content-items/{contentItemId}`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}`</small>

Get a Content Item

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Item |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "locale": "en-GB",
  "version": 1,
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedVersion": 1,
  "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
  "lastUnpublishedVersion": 1,
  "publishingStatus": "NONE",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "workflow": {
    "state": "00112233445566778899aabb"
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Update content item

`PATCH /content-items/{contentItemId}`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}`</small>

Update a Content Item. Please note that deliveryKey can only be set when [Content Delivery v2](https://amplience.com/developers/docs/apis/content-delivery/content-delivery-overview/) is enabled.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |
| `ignoreSchemaValidation` | query | boolean |  | When `true`, the content item body is not validated against the content type schema. Use with caution. Invalid content may cause delivery errors. |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body` | object |  |  |
| `label` | string |  | Label |
| `folderId` | string |  | Folder ID |
| `assignees` | array |  | Assignees |
| `locale` | string |  | Locale |
| `version` | integer | ✓ | The current version number of the content item. Must match the stored version to prevent overwriting concurrent edits. If the version supplied does not match the current version, a 400 error is returned. |

<details>
<summary>Request example</summary>

```json
{
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "locale": "en-GB"
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Updated Content Item |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "locale": "en-GB",
  "version": 1,
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedVersion": 1,
  "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
  "lastUnpublishedVersion": 1,
  "publishingStatus": "NONE",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "workflow": {
    "state": "00112233445566778899aabb"
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Archive content item

`POST /content-items/{contentItemId}/archive`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/archive`</small>

Archive a Content Item

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | integer | ✓ | Version to archive |

<details>
<summary>Request example</summary>

```json
{
  "version": 1
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Item |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "locale": "en-GB",
  "version": 1,
  "status": "ARCHIVED",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedVersion": 1,
  "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
  "lastUnpublishedVersion": 1,
  "publishingStatus": "NONE",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "workflow": {
    "state": "00112233445566778899aabb"
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Get content item associations

`GET /content-items/{contentItemId}/associations`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/associations`</small>

Get Content Item Associations

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Get Content Item Associations response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
  "associations": [
    {
      "eventTitle": "Test",
      "eventId": "00112233445566778899aabb",
      "eventStart": "2019-01-01T00:00:00.000Z",
      "eventEnd": "2019-01-01T00:00:00.000Z",
      "editionTitle": "Test",
      "editionId": "00112233445566778899aabb",
      "editionStart": "2019-01-01T00:00:00.000Z",
      "editionEnd": "2019-01-01T00:00:00.000Z",
      "editionPubStatus": "DRAFT",
      "editionSlotTitle": "Simple Slot",
      "editionSlotId": "00112233445566778899aabb",
      "editionSlotLocked": true,
      "editionSlotLastModifiedDate": "2019-01-01T00:00:00.000Z",
      "editionContentTitle": null,
      "editionContentId": null,
      "editionContentLocked": null,
      "editionContentLastModifiedDate": null,
      "editionContentMultiRoot": false,
      "snapshotComments": "This is an example snapshot.",
      "snapshotCreatedBy": "user",
      "snapshotCreatedDate": "2019-01-01T00:00:00.000Z",
      "snapshotId": "00112233445566778899aabb",
      "usageCount": 1,
      "snapshotLocale": "en-GB",
      "contentTypeSchema": "http://deliver.bigcontent.io/schema/simple-slot-type.json",
      "_links": {
        "get-content": {
          "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
        },
        "update-content": {
          "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}",
          "templated": true
        }
      }
    },
    {
      "eventTitle": "Test",
      "eventId": "00112233445566778899aabb",
      "eventStart": "2019-01-01T00:00:00.000Z",
      "eventEnd": "2019-01-01T00:00:00.000Z",
      "editionTitle": "Test",
      "editionId": "00112233445566778899aabb",
      "editionStart": "2019-01-01T00:00:00.000Z",
      "editionEnd": "2019-01-01T00:00:00.000Z",
      "editionPubStatus": "DRAFT",
      "editionSlotTitle": null,
      "editionSlotId": null,
      "editionSlotLocked": null,
      "editionSlotLastModifiedDate": null,
      "editionContentTitle": "Banner Ad Homepage",
      "editionContentId": "00112233445566778899aabb",
      "editionContentLocked": true,
      "editionContentLastModifiedDate": "2019-01-01T00:00:00.000Z",
      "editionContentMultiRoot": true,
      "snapshotComments": "This is an example snapshot.",
      "snapshotCreatedBy": "user",
      "snapshotCreatedDate": "2019-01-01T00:00:00.000Z",
      "snapshotId": "00112233445566778899aabb",
      "usageCount": 1,
      "snapshotLocale": "en-GB",
      "contentTypeSchema": null,
      "_links": {
        "get-editionContent": {
          "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb"
        },
        "update-editionContent": {
          "href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}",
          "templated": true
        }
      }
    }
  ],
  "_links": {
    "edition-slot-associations": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/edition-slot-associations"
    },
    "content-item-associations": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/associations"
    }
  }
}
```

</details>

### Assigning a delivery key

`PATCH /content-items/{contentItemId}/delivery-key`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/delivery-key`</small>

Assign a delivery key to a content item or slot and replace any existing key. The delivery key must meet the validation rules and be unique within the hub.

 The current version of the content item must be included in the request payload. If the version specified is not the current one, then a 400 error will be returned in the response.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `deliveryKey` | string | ✓ | Delivery key |
| `version` | number | ✓ | Version |

<details>
<summary>Request example</summary>

```json
{
  "deliveryKey": "promo-page/main-banner",
  "version": 1
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Assign Content Item Delivery Key response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "locale": "en-GB",
  "version": 1,
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedVersion": 1,
  "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
  "lastUnpublishedVersion": 1,
  "publishingStatus": "NONE",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "workflow": {
    "state": "00112233445566778899aabb"
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### List content item history

`GET /content-items/{contentItemId}/history`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/history`</small>

List Content Item History

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | List Content Item History response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-item-history": [
      {
        "summary": [
          {
            "action": {
              "code": "UPDATED"
            },
            "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
            "createdDate": "2019-01-01T00:00:00.000Z",
            "historyEventId": "00112233-4455-6677-8899-aabbccddeeff"
          }
        ],
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "version": 1,
        "_links": {
          "content-item-version": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1"
          },
          "content-item-version-history": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history{?page,sort,size}"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/history?page=0&size=20"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}
```

</details>

### Localize content item

`POST /content-items/{contentItemId}/localize`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/localize`</small>

Localize a Content Item. Creates new localized copies of the content item for each requested locale.

> **Note: Locale prerequisite**
> The source content item must have a locale set before localization can be triggered. Use [Assigning locales to Content Items](https://amplience.com/developers/docs/apis/content-management-reference/workflows-localization/#assigning-locales-to-content-items) (`POST /content-items/{contentItemId}/locale`) to set the source locale (for example `en-GB`) first. Calling this endpoint without a source locale set will fail.

This operation is asynchronous and returns a `202 Accepted` response immediately. To poll the status of the localization job, follow the `findByRootContentItem` link in the response. This points to the [Localization Jobs](https://amplience.com/developers/docs/apis/content-management-reference/workflows-localization/#localization) endpoint. The job `status` field will be `IN_PROGRESS` until complete.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `locales` | array | ✓ | List of locales |
| `version` | integer | ✓ | Content item version number |
| `replicateFolderStructure` | boolean |  | When true, the new localized content items will be placed into the same folder as the origin content item. If localizing across repositories then the folder structure of the origin content item will be replicated in the destination repository for the new localized content items. |

<details>
<summary>Request example</summary>

```json
{
  "locales": [
    "fr-FR",
    "de-DE"
  ],
  "version": 1,
  "replicateFolderStructure": true
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 202 | Content Item |

<details>
<summary>Response Example (202)</summary>

```json
{
  "status": "IN_PROGRESS",
  "rootContentItem": {
    "label": "l10n",
    "locale": "en-GB",
    "id": "00112233-4455-6677-8899-aabbccddeeff"
  },
  "requestedLocale": [
    "fr-FR",
    "de-DE"
  ],
  "replicateFolderStructure": true,
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "_links": {
    "content-root": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "findByRootContentItem": {
      "href": "https://api.amplience.net/v2/content/localization-jobs/search/findByRootContentItem?id=00112233-4455-6677-8899-aabbccddeeff{&page,size,sort}",
      "templated": true
    }
  }
}
```

</details>

### Finding content by epoch

`GET /content-items/{contentItemId}/planned`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/planned`</small>

Find content items that are candidates for being published at a point in time.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `epoch` | query | number |  | Epoch Time<br/>Example: `1546300800` |
| `time` | query | number |  | Time<br/>Example: `2019-01-01T00:00:00.000Z` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Finding Content by Epoch response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "folderId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "Name",
      "schema": "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Heading",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "version": 1,
  "label": "Label",
  "status": "ACTIVE",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1"
    },
    "content-item-version-history": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history{?page,size,sort}",
      "templated": true
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "content-item-version": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}",
      "templated": true
    },
    "content-item-versions": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}",
      "templated": true
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-item-with-children": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item-with-parents": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithParents?id=00112233-4455-6677-8899-aabbccddeeff"
    }
  }
}
```

</details>

### Publish content item

`POST /content-items/{contentItemId}/publish`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/publish`</small>

Publish a Content Item. Publishing is asynchronous. The response body is empty, but the `Location` response header contains the URL of the created [Publishing Job](https://amplience.com/developers/docs/apis/content-management-reference/snapshots-publishing/#get-a-publishing-job). Poll that URL to track the job state through `CREATED` → `PREPARING` → `WAITING` → `PUBLISHING` → `COMPLETED` (or `FAILED`). The job can be cancelled by sending `PATCH` to the same URL with `{"state": "CANCELLED"}`.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

**Responses**

| Status | Description |
|--------|-------------|
| 204 | No Content. The `Location` response header contains the Publishing Job URL. |

<details>
<summary>Response Headers (204)</summary>

```http
Location: https://api.amplience.net/v2/content/publishing-jobs/68a83ba8f0c94d9ab9b515e01ec70d28
```

Follow the `Location` URL to retrieve and poll the Publishing Job. See [Get a Publishing Job](https://amplience.com/developers/docs/apis/content-management-reference/snapshots-publishing/#get-a-publishing-job).

</details>

### Restore content by content version number

`PUT /content-items/{contentItemId}/restore`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/restore`</small>

Restore Content by Content Version Number

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | number | ✓ | Version |
| `restoreVersion` | number | ✓ | Restore Version |

<details>
<summary>Request example</summary>

```json
{
  "version": 2,
  "restoreVersion": 1
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | List Content Item Versions |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "folderId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "Name",
      "schema": "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Heading",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "version": 1,
  "label": "Label",
  "status": "ACTIVE",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Unarchive content item

`POST /content-items/{contentItemId}/unarchive`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/unarchive`</small>

Unarchive a Content Item

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | integer | ✓ | Version to unarchive |

<details>
<summary>Request example</summary>

```json
{
  "version": 1
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Item |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "locale": "en-GB",
  "version": 1,
  "status": "ACTIVE",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedVersion": 1,
  "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
  "lastUnpublishedVersion": 1,
  "publishingStatus": "NONE",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "workflow": {
    "state": "00112233445566778899aabb"
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Unpublish content item

`POST /content-items/{contentItemId}/unpublish`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/unpublish`</small>

Unpublish a Content Item

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

**Responses**

| Status | Description |
|--------|-------------|
| 202 | Accepted |

### List content item versions

`GET /content-items/{contentItemId}/versions`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/versions`</small>

List Content Item Versions

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | List Content Item Versions |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "folderId": "00112233445566778899aabb",
        "body": {
          "_meta": {
            "name": "Main-Banner",
            "schema": "http://deliver.bigcontent.io/schema/nested/nested-type.json",
            "deliveryKey": "promo-page/main-banner"
          }
        },
        "heading": "Main-Banner",
        "link": "http://anyafinn.com/buymore?campaign=shouting"
      }
    ],
    "version": 1,
    "label": "Label",
    "status": "ACTIVE",
    "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
    "createdDate": "2019-01-01T00:00:00.000Z",
    "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
    "lastModifiedDate": "2019-01-01T00:00:00.000Z",
    "assignees": [
      "00112233445566778899aabb"
    ],
    "assignedDate": "2019-01-01T00:00:00.000Z",
    "deliveryId": "00112233-4455-6677-8899-aabbccddeeff"
  },
  "_links": {
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1"
    },
    "content-item-version-history": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history{?page,size,sort}",
      "templated": true
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "content-item-version": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}",
      "templated": true
    },
    "content-item-versions": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}",
      "templated": true
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-item-with-children": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item-with-parents": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithParents?id=00112233-4455-6677-8899-aabbccddeeff"
    }
  }
}
```

</details>

### Finding content by content version number

`GET /content-items/{contentItemId}/versions/{version}`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/versions/{version}`</small>

Finding Content by Content Version Number

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |
| `version` | query | number |  | Version<br/>Example: `1` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | List Content Item Versions |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "folderId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "Name",
      "schema": "http://deliver.bigcontent.io/schema/nested/nested-type.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Heading",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "version": 1,
  "label": "Label",
  "status": "ACTIVE",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1"
    },
    "content-item-version-history": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history{?page,size,sort}",
      "templated": true
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "content-item-version": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{/version}",
      "templated": true
    },
    "content-item-versions": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions{?page,size,sort}",
      "templated": true
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-item-with-children": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item-with-parents": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithParents?id=00112233-4455-6677-8899-aabbccddeeff"
    }
  }
}
```

</details>

### List content item history for a version

`GET /content-items/{contentItemId}/versions/{version}/history`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/versions/{version}/history`</small>

List Content Item History for a Version

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |
| `version` | path | string | ✓ | Version<br/>Example: `1` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | List Content Item History for a Version response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-item-version-history": [
      {
        "historyEventId": "00112233-4455-6677-8899-aabbccddeeff",
        "contentItemId": "00112233445566778899aabb",
        "version": 1,
        "createdDate": "2019-01-01T00:00:00.000Z",
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "action": {
          "code": "CREATED"
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/versions/1/history?page=0&size=20"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}
```

</details>

### Assigning a workflow state

`PATCH /content-items/{contentItemId}/workflow`

<small>`https://api.amplience.net/v2/content/content-items/{contentItemId}/workflow`</small>

Assign or unassign a Workflow State on a Content Item. To unassign the current workflow state, omit the `state` field or set it to `null`.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentItemId` | path | string | ✓ | Content Item ID<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | integer | ✓ | Current version of the content item |
| `state` | string |  | Workflow State ID. Omit or set to `null` to remove the current workflow state. |

<details>
<summary>Request example</summary>

```json
{
  "version": 1,
  "state": "00112233445566778899aabb"
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Item |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "locale": "en-GB",
  "version": 1,
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedVersion": 1,
  "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
  "lastUnpublishedVersion": 1,
  "publishingStatus": "NONE",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "workflow": {
    "state": "00112233445566778899aabb"
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Getting linked child content items

`GET /content-items/search/findByIdWithChildren`

<small>`https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren`</small>

Get Linked Child Content Items

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `id` | query | string | ✓ | Id<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Get Linked Child Content Items response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "folderId": "00112233445566778899aabb",
        "body": {
          "_meta": {
            "name": "Name",
            "schema": "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json",
            "deliveryKey": "promo-page/main-banner"
          },
          "nested": {
            "_meta": {
              "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
            },
            "contentType": "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json",
            "id": "00112233-4455-6677-8899-aabbccddeeff"
          }
        },
        "version": 1,
        "label": "Label",
        "status": "ACTIVE",
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
        "lastModifiedDate": "2019-01-01T00:00:00.000Z",
        "assignees": [
          "00112233445566778899aabb"
        ],
        "assignedDate": "2019-01-01T00:00:00.000Z",
        "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
          },
          "content-item": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
            "templated": true
          },
          "planned": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
            "templated": true
          },
          "publish": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithChildren?id=00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 22 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Getting linked parent content items

`GET /content-items/search/findByIdWithParents`

<small>`https://api.amplience.net/v2/content/content-items/search/findByIdWithParents`</small>

Get Linked Parent Content Items

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `id` | query | string | ✓ | Id<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Get Linked Parent Content Items response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "folderId": "00112233445566778899aabb",
        "body": {
          "_meta": {
            "name": "Name",
            "schema": "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json",
            "deliveryKey": "promo-page/main-banner"
          },
          "nested": {
            "_meta": {
              "schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link"
            },
            "contentType": "http://deliver.bigcontent.io/schema/linked-content-validation/nestable.json",
            "id": "00112233-4455-6677-8899-aabbccddeeff"
          }
        },
        "version": 1,
        "label": "Label",
        "status": "ACTIVE",
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
        "lastModifiedDate": "2019-01-01T00:00:00.000Z",
        "assignees": [
          "00112233445566778899aabb"
        ],
        "assignedDate": "2019-01-01T00:00:00.000Z",
        "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
          },
          "content-item": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
            "templated": true
          },
          "planned": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
            "templated": true
          },
          "publish": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/search/findByIdWithParents?id=00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 22 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### List content items

`GET /content-repositories/{contentRepositoryId}/content-items`

<small>`https://api.amplience.net/v2/content/content-repositories/{contentRepositoryId}/content-items`</small>

This lists all of the Content Items within this Content Repository

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentRepositoryId` | path | string | ✓ | Content Repository ID<br/>Example: `00112233445566778899aabb` |
| `projection` | query | string (projection) |  | "basic" - omits the body property from the return Content Items<br/>Example: `basic` |
| `page` | query | integer |  | Page number<br/>Example: `0` |
| `folderId` | query | string |  | Folder ID<br/>Example: `00112233445566778899aabb` |
| `status` | query | string |  | Status |
| `excludeHierarchicalChildren` | query | boolean |  | Exclude hierarchical child items<br/>Example: `True` |
| `size` | query | integer |  | Page size<br/>Example: `20` |
| `sort` | query | string |  | Sort paramter<br/>Example: `createdDate,asc` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Repository |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "body": {
          "_meta": {
            "name": "main-banner",
            "schema": "http://example.com/banner.json",
            "deliveryKey": "promo-page/main-banner"
          },
          "heading": "Buy more stuff!!",
          "link": "http://anyafinn.com/buymore?campaign=shouting"
        },
        "label": "Banner Ad Homepage",
        "folderId": "00112233445566778899aabb",
        "assignees": [
          "00112233445566778899aabb"
        ],
        "assignedDate": "2019-01-01T00:00:00.000Z",
        "locale": "en-GB",
        "version": 1,
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
        "lastModifiedDate": "2019-01-01T00:00:00.000Z",
        "lastPublishedDate": "2019-01-01T00:00:00.000Z",
        "lastPublishedVersion": 1,
        "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
        "lastUnpublishedVersion": 1,
        "publishingStatus": "NONE",
        "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
        "workflow": {
          "state": "00112233445566778899aabb"
        },
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
          },
          "content-item": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
            "templated": true
          },
          "planned": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
            "templated": true
          },
          "publish": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20"
    },
    "search": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff/search"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Create content item

`POST /content-repositories/{contentRepositoryId}/content-items`

<small>`https://api.amplience.net/v2/content/content-repositories/{contentRepositoryId}/content-items`</small>

Create a Content Item. Please note that deliveryKey can only be set when [Content Delivery v2](https://amplience.com/developers/docs/apis/content-delivery/content-delivery-overview/) is enabled. Copying a content item will not copy the deliveryKey.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentRepositoryId` | path | string | ✓ | Content Repository ID<br/>Example: `00112233445566778899aabb` |
| `ignoreSchemaValidation` | query | boolean |  | When `true`, the content item body is not validated against the content type schema. Use with caution. Invalid content may cause delivery errors. |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body` | object | ✓ |  |
| `label` | string | ✓ | Label |
| `folderId` | string |  | Folder ID |
| `assignees` | array |  | Assignees |
| `locale` | string |  | Locale |
| `workflow` | object |  |  |

<details>
<summary>Request example: Create content item</summary>

```json
{
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "locale": "en",
  "assignees": [
    "a79f0b27-5934-4154-9cda-36399e011c68",
    "cbda3aa3-ebc4-4bb1-84a5-d9b31990c703"
  ]
}
```

</details>

<details>
<summary>Request example: Slot content item</summary>

```json
{
  "body": {
    "_meta": {
      "name": "simple-slot",
      "schema": "http://example.com/simple-slot-type.json"
    }
  },
  "label": "Simple Slot"
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 201 | Created Content Item |

<details>
<summary>Response example (201): Create content item</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "folderId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version": 1,
  "label": "Banner Ad Homepage",
  "status": "ACTIVE",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "assignee": "00112233-4455-6677-8899-aabbccddeeff",
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 21 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Copy content item

`POST /content-repositories/{contentRepositoryId}/content-items/{sourceContentItemId}`

<small>`https://api.amplience.net/v2/content/content-repositories/{contentRepositoryId}/content-items/{sourceContentItemId}`</small>

Copy a Content Item. Please note that deliveryKey can only be set when [Content Delivery v2](https://amplience.com/developers/docs/apis/content-delivery/content-delivery-overview/) is enabled. Copying a content item will not copy the deliveryKey.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `contentRepositoryId` | path | string | ✓ | Content Repository ID<br/>Example: `00112233445566778899aabb` |
| `sourceContentItemId` | path | string | ✓ | Source Content Item ID (used to copy an existing Content Item)<br/>Example: `00112233-4455-6677-8899-aabbccddeeff` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body` | object | ✓ |  |
| `label` | string | ✓ | Label |
| `folderId` | string |  | Folder ID |
| `assignees` | array |  | Assignees |
| `locale` | string |  | Locale |
| `workflow` | object |  |  |

<details>
<summary>Request example: Copy content item</summary>

```json
{
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "locale": "en"
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 201 | Created Content Item |

<details>
<summary>Response example (201): Copy content item</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "folderId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "version": 1,
  "label": "Banner Ad Homepage",
  "status": "ACTIVE",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 21 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Faceting content items with search by text

`POST /hubs/{hubId}/content-items/facet`

<small>`https://api.amplience.net/v2/content/hubs/{hubId}/content-items/facet`</small>

Facet content items and search by text. See [Text Search Query Syntax](#text-search-query-syntax) for a summary of the query syntax.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | path | string | ✓ | Hub ID<br/>Example: `00112233445566778899aabb` |
| `sort` | query | string |  | Sort<br/>Example: `createdDate` |
| `createdDate.dir` | query | string (asc, desc) |  | Direction of sort<br/>Example: `desc` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `fields` | array | ✓ | Array of facet field definitions. Each entry defines one facet dimension. See field schema below. |
| `returnEntities` | boolean |  | When `true`, matching content items are included in the response alongside facet counts. |

**Facet field schema**

Each object in the `fields` array supports the following properties:

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `facetAs` | string | ✓ | Facet type. `ENUM` groups results by distinct values; `DATE` groups by date ranges. |
| `field` | string | ✓ | The content item field to facet on. Common values: `schema`, `assignees`, `workflow.state`, `publishingStatus`, `locale`, `lastModifiedDate`, `createdDate`. |
| `userFacingName` | string |  | Display name for the facet |
| `filter` | object |  | For `ENUM` facets: pre-filters results to items matching this value. |
| `filter.type` | string |  | Filter operator. `EQ` matches a single value; `IN` matches any value in an array. |
| `filter.values` | string or array |  | The value(s) to filter by. Use an array with `IN`. |
| `range` | object |  | For `DATE` facets: defines the date range |
| `range.start` | string |  | Range start. ISO 8601 date, or a relative expression such as `NOW`, `-7:DAYS`, `-30:DAYS`, `-60:DAYS`. |
| `range.end` | string |  | Range end. Same format as `range.start`. |

<details>
<summary>Request example</summary>

```json
{
  "fields": [
    {
      "facetAs": "ENUM",
      "filter": {
        "type": "EQ",
        "values": [
          "http://deliver.bigcontent.io/schema/nested/nested-type.json"
        ]
      },
      "field": "schema",
      "userFacingName": "Schema"
    }
  ],
  "returnEntities": true
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Item Facet response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "folderId": "00112233445566778899aabb",
        "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
        "schema": "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "version": 1,
        "status": "ACTIVE",
        "label": "Label",
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
        "lastModifiedDate": "2019-01-01T00:00:00.000Z",
        "assignees": [
          "00112233445566778899aabb"
        ],
        "assignedDate": "2019-01-01T00:00:00.000Z",
        "_links": {
          "publish": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
          },
          "planned": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
            "templated": true
          },
          "content-item": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
            "templated": true
          },
          "self": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/..."
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  },
  "_facets": {
    "schema": [
      {
        "_id": "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "count": 1
      }
    ]
  }
}
```

</details>

### Filtering content items by collection keys

`POST /hubs/{hubId}/content-items/filter`

<small>`https://api.amplience.net/v2/content/hubs/{hubId}/content-items/filter`</small>

Filter content items using Collection Keys.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | path | string | ✓ | Hub ID<br/>Example: `00112233445566778899aabb` |

**Request Body**

Content-Type: `application/json`

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `collectionKey` | string | ✓ | collectionKey<br/>`hubName:`<br/>`527c95fd10c77e96b5164633b445271ffc0392031b6c99448cbaec579767b76b` |
| `sortBy` | object |  |  |
| `page` | object |  |  |

<details>
<summary>Request example</summary>

```json
{
  "collectionKey": "hubName:527c95fd10c77e96b5164633b445271ffc0392031b6c99448cbaec579767b76b",
  "sortBy": {
    "order": "asc"
  },
  "page": {
    "cursor": "SSBhbSBhIGhhdGNoZWQtZWFzdGVyLWVnZy4gUGxlYXNlIGRvbid0IGRlY29kZSBtZS4="
  }
}
```

</details>

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Item filter response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "body": {
          "_meta": {
            "name": "main-banner",
            "schema": "http://example.com/banner.json",
            "deliveryKey": "promo-page/main-banner"
          },
          "heading": "Buy more stuff!!",
          "link": "http://anyafinn.com/buymore?campaign=shouting"
        },
        "label": "Banner Ad Homepage",
        "folderId": "00112233445566778899aabb",
        "assignees": [
          "00112233445566778899aabb"
        ],
        "assignedDate": "2019-01-01T00:00:00.000Z",
        "locale": "en-GB",
        "version": 1,
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
        "lastModifiedDate": "2019-01-01T00:00:00.000Z",
        "lastPublishedDate": "2019-01-01T00:00:00.000Z",
        "lastPublishedVersion": 1,
        "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
        "lastUnpublishedVersion": 1,
        "publishingStatus": "NONE",
        "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
        "workflow": {
          "state": "00112233445566778899aabb"
        },
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
          },
          "content-item": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
            "templated": true
          },
          "planned": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
            "templated": true
          },
          "publish": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
          }
        }
      }
    ]
  },
  "page": {
    "cursor": "SSBhbSBhIGhhdGNoZWQtZWFzdGVyLWVnZy4gUGxlYXNlIGRvbid0IGRlY29kZSBtZS4=",
    "count": 1
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233-4455-6677-8899-aabbccddeeff/content-items/filter"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.

### Search content items by text

`GET /hubs/{hubId}/content-items/find`

<small>`https://api.amplience.net/v2/content/hubs/{hubId}/content-items/find`</small>

Text is the default search field. See [Text Search Query Syntax](#text-search-query-syntax) for a summary of the query syntax.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | path | string | ✓ | Hub ID<br/>Example: `00112233445566778899aabb` |
| `query` | query | string | ✓ | Query<br/>Example: `uniondusk` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Search Content Items by Text response |

<details>
<summary>Response Example (200)</summary>

```json
{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "folderId": "00112233445566778899aabb",
        "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
        "schema": "http://deliver.bigcontent.io/schema/nested/nested-type.json",
        "version": 1,
        "status": "ACTIVE",
        "label": "Label",
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
        "lastModifiedDate": "2019-01-01T00:00:00.000Z",
        "assignees": [
          "00112233445566778899aabb"
        ],
        "assignedDate": "2019-01-01T00:00:00.000Z",
        "_links": {
          "publish": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
          },
          "planned": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
            "templated": true
          },
          "content-item": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
            "templated": true
          },
          "self": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/..."
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}
```

</details>

### Finding content items by delivery keys

`GET /hubs/{hubId}/delivery-keys/content-item`

<small>`https://api.amplience.net/v2/content/hubs/{hubId}/delivery-keys/content-item`</small>

Find content items using the Delivery Key.

**Parameters**

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | path | string | ✓ | Hub ID<br/>Example: `00112233445566778899aabb` |
| `key` | query | string | ✓ | The delivery key<br/>Example: `promo-page/main-banner` |

**Responses**

| Status | Description |
|--------|-------------|
| 200 | Content Item |

<details>
<summary>Response Example (200)</summary>

```json
{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "contentRepositoryId": "00112233445566778899aabb",
  "body": {
    "_meta": {
      "name": "main-banner",
      "schema": "http://example.com/banner.json",
      "deliveryKey": "promo-page/main-banner"
    },
    "heading": "Buy more stuff!!",
    "link": "http://anyafinn.com/buymore?campaign=shouting"
  },
  "label": "Banner Ad Homepage",
  "folderId": "00112233445566778899aabb",
  "assignees": [
    "00112233445566778899aabb"
  ],
  "assignedDate": "2019-01-01T00:00:00.000Z",
  "locale": "en-GB",
  "version": 1,
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
  "lastModifiedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedDate": "2019-01-01T00:00:00.000Z",
  "lastPublishedVersion": 1,
  "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
  "lastUnpublishedVersion": 1,
  "publishingStatus": "NONE",
  "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
  "workflow": {
    "state": "00112233445566778899aabb"
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
      "templated": true
    },
    "planned": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
      "templated": true
    },
    "publish": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
    }
  }
}
```

</details>

> **Note: Abbreviated response**
> The `_links` object in this example is truncated for readability: it shows 4 of the 24 links the API actually returns. Every content item response includes the full standard set. See [Content item response links](#content-item-response-links) for the complete list.