API reference
Help centerCommunityDevelopersAcademyStatus

Retrieve all layouts in the database.

get
https://example.com/authoring/v1/layouts

Use the /layouts endpoint to retrieve all layouts from the database.
User roles: admin, manager, editor, viewer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
Defaults to 0

Use the offset parameter to specify the number of layouts to skip and return the rest.

number
Defaults to 50

Set the limit for the number of layouts that are returned.

string
enum

Specify the result format.

  • feed - (default) returns a wrapper with links
  • array - returns just the array of results
  • sequence - each result is a separate JSON document on a new line
Allowed:
string
enum

Specify the next and previous page link mode.

  • offset - (default) allows paging forward or backwards, but only a small number of times
  • deep - uses index keys to efficiently page through a large result set, but only in one direction
Allowed:
string
enum
Defaults to ascending

Specify whether you want the layouts to be returned in ascending/alphabetical (default) or descending/reverse-alphabetical order.

Allowed:
string

Only the layout fields that are specified here are returned for each result. Any layout field is a valid value and can be specified as a comma-separated list.

Responses

Updated 3 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago