---
updatedAt: 2026-04-08T10:20:55.000Z
agentTools:
projectIndex: https://developer.goacoustic.com/acoustic-content/llms.txt
---
# Retrieve all layout mappings in the database.
Use the /layout-mappings endpoint to retrieve all layout mappings from the database.
User roles: admin, manager, editor, viewer
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"version": "1.0.142",
"x-ibm-name": "ibm-watson-content-hub-api",
"title": "Acoustic Content API",
"description": "Copyright © Acoustic, L.P. 2019"
},
"tags": [
{
"name": "Authoring layouts",
"description": "Use the Content content authoring layout service Rest APIs to work with layouts and layout mappings.\n\nLayouts define the template for the type documents. They define the markup and how to add content properties and elements into the markup. For example, the layouts 'Article', and 'Event' would define what an article or event looks like on the web site, or email.\n\nLayout Mappings define an association between a content-type and one or more layouts. Specifically marking those layouts as valid for the given content-type.\n"
}
],
"paths": {
"/authoring/v1/layout-mappings": {
"get": {
"tags": [
"Authoring layouts"
],
"summary": "Retrieve all layout mappings in the database.",
"description": "Use the /layout-mappings endpoint to retrieve all layout mappings from the database.
User roles: admin, manager, editor, viewer",
"parameters": [
{
"name": "offset",
"in": "query",
"description": "Use the offset parameter to specify the number of layout mappings to skip and return the rest.",
"required": false,
"schema": {
"type": "number",
"format": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Set the limit for the number of layout mappings that are returned.",
"required": false,
"schema": {
"type": "number",
"format": "integer",
"default": 50
}
},
{
"name": "format",
"in": "query",
"required": false,
"description": "Specify the result format.\n * `feed` - (default) returns a wrapper with links\n * `array` - returns just the array of results\n * `sequence` - each result is a separate JSON document on a new line\n",
"schema": {
"type": "string",
"enum": [
"feed",
"array",
"sequence"
]
}
},
{
"name": "pageMode",
"in": "query",
"required": false,
"description": "Specify the next and previous page link mode.\n * `offset` - (default) allows paging forward or backwards, but only a small number of times\n * `deep` - uses index keys to efficiently page through a large result set, but only in one direction\n",
"schema": {
"type": "string",
"enum": [
"offset",
"deep"
]
}
},
{
"name": "order",
"in": "query",
"description": "Specify whether you want the layout mappings to be returned in ascending (default) or descending order.",
"required": false,
"schema": {
"type": "string",
"enum": [
"ascending",
"descending"
],
"default": "ascending"
}
},
{
"name": "fields",
"in": "query",
"description": "Only the layout mapping fields that are specified here are returned for each result. Any layout mapping field is a valid value and can be specified as a comma-separated list.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "A query result that returns layout mappings.",
"properties": {
"offset": {
"type": "integer",
"description": "number of results to skip."
},
"limit": {
"type": "integer",
"description": "number of results to return."
},
"href": {
"type": "string",
"description": "the url of the current query."
},
"next": {
"type": "string",
"description": "the url for the next page of results. Only present if there are more results."
},
"previous": {
"type": "string",
"description": "the url for the previous page of results. Not present when on the first page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"description": "An existing layout mapping.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the layout mapping.",
"pattern": "^[a-zA-Z0-9*.\\-+_~$!',()]*$",
"minLength": 1,
"example": "e0192c4c-9633-4853-856a-ce04e37ec40c"
},
"rev": {
"type": "string",
"description": "The current revision of the layout mapping.",
"minLength": 1,
"example": "1d5fc65f4cd277eb5340355db7ecdfde75"
},
"name": {
"type": "string",
"description": "The name of the layout mapping.",
"pattern": "^[a-zA-Z0-9*. \\-+_~$!',()]*$",
"minLength": 1,
"example": "Sample layout mapping"
},
"classification": {
"type": "string",
"description": "Indicates the type of this document.",
"enum": [
"layout-mapping"
]
},
"creatorId": {
"type": "string",
"description": "The ID of the user that created the layout mapping.",
"example": "8c622bbb-5f5b-45d4-89e1-fce1c054138f"
},
"creator": {
"type": "string",
"description": "The display name of the user that created the layout mapping. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.\nThis field is read only.\n",
"example": "Thomas Watson"
},
"created": {
"type": "string",
"description": "The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.",
"format": "date-time",
"example": "2016-11-02T06:28:47Z"
},
"lastModifierId": {
"type": "string",
"description": "The ID of the user that last modified the layout mapping.",
"example": "8c622bbb-5f5b-45d4-89e1-fce1c054138f"
},
"lastModifier": {
"type": "string",
"description": "The display name of the last user that modified the layout mapping. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.\nThis field is read only.\n",
"example": "Thomas Watson"
},
"lastModified": {
"type": "string",
"description": "The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.",
"format": "date-time",
"example": "2016-11-02T06:28:47Z"
},
"path": {
"type": "string",
"description": "Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].",
"example": "/myLayoutMappings/SampleMapping.json"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"example": [
"news",
"sample"
]
},
"type": {
"type": "object",
"description": "The mapped content-type. Must be unique.\nDuring create and update operations, the mapped content-type can be referred to by either id or name.\n",
"properties": {
"id": {
"type": "string",
"description": "The ID of the mapped content-type.",
"pattern": "^[a-zA-Z0-9*.\\-+_~$!',()]*$",
"minLength": 1,
"example": "092c46f6-09c0-4ffe-9f21-52d041b4a73c"
},
"name": {
"type": "string",
"description": "The name of the mapped content-type. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.\n",
"example": "Sample Type"
}
}
},
"mappings": {
"type": "array",
"description": "The mapped layouts.",
"items": {
"type": "object",
"description": "an individual layout mapping entry.\nDuring creates and updates, if there is only one layout specified within the 'layouts' property, then the 'defaultLayout' property is optional (and will be inserted by the system).\n",
"properties": {
"defaultLayout": {
"type": "object",
"description": "an individual layout reference.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the referenced layout.",
"pattern": "^[a-zA-Z0-9*.\\-+_~$!',()]*$",
"minLength": 1,
"example": "f26044ca-d92d-49e8-acd9-00563c1e0db9"
},
"name": {
"type": "string",
"description": "The name of the referenced layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.\nThis field is read only.\n",
"example": "Sample Layout"
}
},
"required": [
"id"
]
},
"layouts": {
"type": "array",
"description": "The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)",
"items": {
"type": "object",
"description": "an individual layout reference.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the referenced layout.",
"pattern": "^[a-zA-Z0-9*.\\-+_~$!',()]*$",
"minLength": 1,
"example": "f26044ca-d92d-49e8-acd9-00563c1e0db9"
},
"name": {
"type": "string",
"description": "The name of the referenced layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.\nThis field is read only.\n",
"example": "Sample Layout"
}
},
"required": [
"id"
]
},
"minItems": 1
}
},
"required": [
"defaultLayout",
"layouts"
]
},
"minItems": 1,
"maxItems": 1
},
"isSystem": {
"type": "boolean",
"description": "Indicates whether this item is a 'system item' or not.",
"default": false
}
},
"required": [
"rev",
"name",
"type",
"mappings"
]
}
}
}
}
}
}
},
"429": {
"description": "Too Many Requests, the server has reached a limit, the request must be sent again at a later time.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-ibm-dx-security-user-roles": [
"admin",
"manager",
"editor",
"viewer"
]
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"description": "This JSON record represents an error condition.",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"description": "This JSON record represents an individual error or warning contained in an error message.",
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "An error code"
},
"message": {
"type": "string",
"description": "A message describing what went wrong."
},
"description": {
"type": "string",
"description": "Further explanation of the error condition and potential next steps to resolve the problem."
},
"more_info": {
"type": "string",
"description": "A URL pointing to a web site that provides more information on the given error condition."
},
"level": {
"type": "string",
"enum": [
"ERROR",
"WARNING"
],
"description": "The severity level of the message. Default is error."
},
"parameters": {
"type": "object",
"description": "Additional properties reflecting the dynamic parts of the error condition."
},
"cause": {
"type": "object",
"description": "This property can be used to transport causing error message records produced by a down stream service calls."
},
"locale": {
"type": "string",
"description": "This property represents the locale of the text contained in properties 'message', and 'description'. This property is mandatory if message and description contain translated text."
}
},
"required": [
"code",
"message"
]
}
},
"requestId": {
"type": "string",
"description": "The ID of the failing request."
},
"service": {
"type": "string",
"description": "The name of the service serving the error message."
}
},
"required": [
"errors",
"requestId"
]
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```