API Reference

Layout Categories

The groups layouts are sorted into in the admin.

Prefix /cdna-api/common ReferenceLayoutCategory model
Layout Categories in Postman

List layout categories#

GET /cdna-api/common/layout-categories

Lists layout categories. Without limit every match comes back.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
LayoutCategory, in the Reference

Parameters

propertiesquery
selector
The fields and relations to return, such as {id,name}.
filtersquery
name=value
Any stored field, or a relation with a dot, such as parent.id=12. Prefix the name with !, >, <, % or |. Use stored field names exactly as in the model, and compare totalCount with the unfiltered list's to confirm a filter applied.
orderByquery
string
field:ASC or field:DESC, comma-separated. Stored fields only.
limitquery
integer
Records per response. There is no default.
offsetquery
integer
Records to skip.

Example

List layout categories 
GET /cdna-api/common/layout-categories?limit=2&properties={id,name} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "name": "Hub"
    }
  ]
}
Open in Postman docs Real response from this documentation site

Show a layout category#

GET /cdna-api/common/layout-category/{id}

Reads one layout category by its id.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
LayoutCategory, in the Reference

Parameters

idpathrequired
integer
The layout category id.
propertiesquery
selector
The fields and relations to return, such as {id,name}.

Example

Show a layout category 
GET /cdna-api/common/layout-category/1?properties={id,name} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "data": {
    "id": 1,
    "name": "Hub"
  }
}
Open in Postman docs Real response from this documentation site