Retrieve an existing layout by its path.

get

https://example.com/authoring/v1/layouts/by-path

Use the /layouts/by-path end-point to retrieve an existing layout from the database.
User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

path

string

required

The path of the layout to retrieve.

fields

string

A comma separated list that when specified, limits the fields returned to just those specified. Any layout field is a valid value.

include

string

A comma separated list of additional fields (which are normally hidden) to add to the response.
Valid options are:
metadata: Adds additional details such as creator and last modifier to the response. all: Adds all current and future additional fields to the response.
When used in-conjunction with the 'fields' option, both sets of fields are returned. ie. those specified in the 'fields' option and those specified in the 'include' option.

Headers

If-None-Match

string

Provide an Etag value from a previous request to check whether the layout retrieved is the most recent version. If the layout is the most recent version, the call returns a 304 ( Not modified) message instead of sending the layout back.

Responses

304

Not modified is returned when using If-None-Match header and the value matches the latest version of the item.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Invalid path OR Invalid input.

403The operation is not available based on the current tenant's tier.

404The document with path {path} was not found OR Current tenant's database is not provisioned.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.