---
title: "Get custom content by type"
method: GET
path: "/custom-content"
tags: ["Custom Content"]
---

# Get custom content by type

`GET /custom-content`

Returns all custom content for a given type. The number of results is limited by the `limit` parameter and additional results (if available)
will be available through the `next` URL present in the `Link` response header.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).

## Query parameters

- `type` string, required
- `id` integer[]
- `space-id` integer[]
- `sort` 'id' | '-id' | 'created-date' | '-created-date' | 'modified-date' | '-modified-date' | 'title' | '-title' — The sort fields for custom content. The default sort direction is ascending. To sort in descending order, append a `-` character before the sort field. For example, `fieldName` or `-fieldName`.
- `cursor` string
- `limit` integer
- `body-format` 'raw' | 'storage' | 'atlas_doc_format' — The formats a custom content body can be represented as. A subset of BodyRepresentation.

## Response `200`

Returned if the requested custom content is returned.

- object
  - `results` CustomContentBulk[]
    - `id` string — ID of the custom content.
    - `type` string — The type of custom content.
    - `status` 'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any' — The status of the content.
    - `title` string — Title of the custom content.
    - `spaceId` string — ID of the space the custom content is in. Note: This is always returned, regardless of if the custom content has a container that is a space.
    - `pageId` string — ID of the containing page. Note: This is only returned if the custom content has a container that is a page.
    - `blogPostId` string — ID of the containing blog post. Note: This is only returned if the custom content has a container that is a blog post.
    - `customContentId` string — ID of the containing custom content. Note: This is only returned if the custom content has a container that is custom content.
    - `authorId` string — The account ID of the user who created this custom content originally.
    - `createdAt` string, date-time — Date and time when the custom content was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
    - `version` Version
      - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
      - `message` string — Message associated with the current version.
      - `number` integer — The version number.
      - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
      - `authorId` string — The account ID of the user who created this version.
    - `body` CustomContentBodyBulk — Contains fields for each representation type requested.
      - `raw` BodyType
        - `representation` string — Type of content representation used for the value field.
        - `value` string — Body of the content, in the format found in the representation field.
      - `storage` BodyType
        - `representation` string — Type of content representation used for the value field.
        - `value` string — Body of the content, in the format found in the representation field.
      - `atlas_doc_format` BodyType
        - `representation` string — Type of content representation used for the value field.
        - `value` string — Body of the content, in the format found in the representation field.
    - `_links` CustomContentLinks
      - `webui` string — Web UI link of the content.
  - `_links` MultiEntityLinks
    - `next` string — Used for pagination. Contains the relative URL for the next set of results, using a cursor query parameter. This property will not be present if there is no additional data available.
    - `base` string — Base url of the Confluence site.

## Other responses

- `400` — Returned if an invalid request is provided.
- `401` — Returned if the authentication credentials are incorrect or missing from the request.
- `404` — Returned if the type of custom content is not found. Note, this is distinct from the type being present, but no instances of the type, which would be a 200 with empty results.

---

[API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api-v2/revisions/c4bd1ed570f2/schema)